Discussion:
Reporting minor documentation errors.
(too old to reply)
EG
2008-03-11 02:02:30 UTC
Permalink
What it the correct method for reporting minor grammar or typographic
errors in the package documentation?

For example, in the FAQ section of the End User Documentation for
Calendar (
http://pear.php.net/manual/en/package.datetime.calendar.faq.php ) I
noted that one of the FAQs is titled, "After calling build(), I just
want to get a single child date object with looping through the lot.
How?" when what I believe they meant was, "After calling build(), I just
want to get a single child date object ***without*** looping through the
lot. How?" It's a small thing but we all contribute what we can.

A bug report seems a bit much for a tiny thing like this and the
guidelines for adding a user note appear to discourage reporting stuff
like this in that way. So how to?

Thanks,
EG
Mark Wiesemann
2008-03-11 13:40:55 UTC
Permalink
Post by EG
What it the correct method for reporting minor grammar or typographic
errors in the package documentation?
[...]
Post by EG
A bug report seems a bit much for a tiny thing like this and the
guidelines for adding a user note appear to discourage reporting stuff
like this in that way. So how to?
The bug tracker is the best place for such reports. If you use the bug
tracker link on bottom of each manual page, you'll get directly to the
right page (bug type "Documentation Problem" and the right page will
already be preselected).

Regards,
Mark
--
http://www.markwiesemann.eu
Brett Bieber
2008-03-11 13:45:11 UTC
Permalink
Post by Mark Wiesemann
Post by EG
What it the correct method for reporting minor grammar or typographic
errors in the package documentation?
[...]
Post by EG
A bug report seems a bit much for a tiny thing like this and the
guidelines for adding a user note appear to discourage reporting stuff
like this in that way. So how to?
The bug tracker is the best place for such reports. If you use the bug
tracker link on bottom of each manual page, you'll get directly to the
right page (bug type "Documentation Problem" and the right page will
already be preselected).
Just fixed this one... but yes, file bugs like Mark says.

I didn't know the page would be preselected though... very slick. :-)
--
Brett Bieber

http://saltybeagle.com/
Continue reading on narkive:
Loading...