People get confused by how to use this module.

It would be nice to have a README.txt and more details about this project on the module page. If you agree I can provide a patch and edit the project page based upon those two issues linked above.

Comments

danielc’s picture

danielc commented

I believe the docblock at the top of the module says what needs to be done. Is it missing anything?

greggles’s picture

greggles
he/him
Primary language English
Location Denver, Colorado, USA
commented

The docblock does cover it, but not many people look there. In order of frequency of looking, I believe most people look at:

1. The project page
2. README.txt / INSTALL.txt
3. The handbooks (especially if linked from the project page)
...
n. The docblock

I'm willing to do the writing/formatting for the project page, handbook, and README.txt but wanted your permission first.

danielc’s picture

danielc commented
Status: Active » Fixed

The instructions are short and sweet, so maintaining a whole series of documentation in various places isn't warranted. I added a note to the module's home page saying that the instructions are in the module file. Thanks.

birdmanx35’s picture

birdmanx35 commented

I don't think it's unwarranted- some people may want to check out the instructions before installing to see how the module works.

Anonymous’s picture

(not verified) commented
Status: Fixed » Closed (fixed)