5 ms·

$ llbin | nlines 738 Apparently I've written 738 bash/python scripts (and counting). Should probably publish those someday...

tambourine_man 9y ago
There's no day like today, as they say
- blunte 9y ago
  Releasing them is one thing. Documenting them is another. This holds many of us back from releasing our work.
  - Jach 9y ago
    If there are some things that are really useful, you can quickly call them out in the readme, but even if you don't people will browse and figure out how to use them anyway if they want to. There are plenty of projects with poor or entirely absent documentation that still see use. In some ways I could see how going through the effort of attempting to have documentation might just make things worse because then people might have an expectation that you're going to keep working on it or respond to filed issues. Anyway I thought the more common excuses were "eh, this isn't that useful, no one will look at it let alone use it", or "I'd have to go through everything and make sure I didn't leave my password in a comment or something stupid", or maybe the most common "there's a lot of hacky code, I don't want to have random people / a potential future employer see this and think I suck at coding..."
  - lolive 9y ago
    I had done a kind of framework to manage my Bash functions as packages (cf http://github.com/lolive/shinyshell http://github.com/lolive/shinyshell). Even the documentation of functions and packages was tool-assisted (à la Javadoc). But documenting is a kind of chicken and egg problem. It requires an outsider point of view, that is difficult to have when you are in the developpent phase, and everything is in your mind. Nevertheless i agree that documentation is a key part of the success of a project.
ejanus 9y ago
Please do
deleted 9y ago
[deleted]

5 ms·

$ llbin | nlines 738 Apparently I've written 738 bash/python scripts (and counting). Should probably publish those someday...

by sillysaurus3 9y ago

tambourine_man 9y ago
There's no day like today, as they say
- blunte 9y ago
  Releasing them is one thing. Documenting them is another. This holds many of us back from releasing our work.
  - Jach 9y ago
    If there are some things that are really useful, you can quickly call them out in the readme, but even if you don't people will browse and figure out how to use them anyway if they want to. There are plenty of projects with poor or entirely absent documentation that still see use. In some ways I could see how going through the effort of attempting to have documentation might just make things worse because then people might have an expectation that you're going to keep working on it or respond to filed issues. Anyway I thought the more common excuses were "eh, this isn't that useful, no one will look at it let alone use it", or "I'd have to go through everything and make sure I didn't leave my password in a comment or something stupid", or maybe the most common "there's a lot of hacky code, I don't want to have random people / a potential future employer see this and think I suck at coding..."
  - lolive 9y ago
    I had done a kind of framework to manage my Bash functions as packages (cf http://github.com/lolive/shinyshell http://github.com/lolive/shinyshell). Even the documentation of functions and packages was tool-assisted (à la Javadoc). But documenting is a kind of chicken and egg problem. It requires an outsider point of view, that is difficult to have when you are in the developpent phase, and everything is in your mind. Nevertheless i agree that documentation is a key part of the success of a project.
ejanus 9y ago
Please do
deleted 9y ago
[deleted]