this post was submitted on 28 Jul 2023
1087 points (99.0% liked)
Programmer Humor
32397 readers
598 users here now
Post funny things about programming here! (Or just rant about your favourite programming language.)
Rules:
- Posts must be relevant to programming, programmers, or computer science.
- No NSFW content.
- Jokes must be in good taste. No hate speech, bigotry, etc.
founded 5 years ago
MODERATORS
you are viewing a single comment's thread
view the rest of the comments
view the rest of the comments
It wastes everyone's time. The project maintainers have to keep answering the same questions, and the users don't have instant access to answers
Why would any sane developer want to use this system to "document" their project? Written docs have worked well for a million years and there's no need to change them.
You can even include them in your version control system and allow others to suggest changes
And you can include separate ones right there in the root folder where the script lives. README.md renders out beautifully on GitHub.