Merge/update old Object.inspect docs into source
Reported by T.J. Crowder | November 16th, 2009 @ 03:56 PM
The attached .pdoc file contains the old
Object.inspect documentation from the website's 1.6.0
API docs (e.g., before the inline documentation). It needs to be
updated and merged into the PDoc in the source.
Comments and changes to this ticket
My first crack at patching the docs.
I'm not certain how much updating you're looking for with the documentation. It mostly matched up content-wise with the current documentation, seems that it was simply the formatting that was updated. How much elaboration should be being done on these? Examples where there are none?
Thanks in advance for any feedback!
Actually most method documentations that are not ported yet in the current source code only contains the excerpt that is visible on index pages (http://prototypejs.org/api/object/#method-inspect) or are missing a few lines and examples as it was the case here. These were manually created by contributors and team members when we decided to use PDoc inline comments.
On the other side, the attached PDoc files have been exported and generated (including formatting) from the old documentation site, and contain the complete documentation for a given method which is visible on its own page (like http://prototypejs.org/api/object/inspect).
This is why you can experience inconsistent formatting between the docs that are present in the current source code and the one that are attached here.
You may have noticed that the current PDoc template system doesn't support the one-page-per-method yet but we're working on it.
Regarding elaboration, merging those two different versions is already a painful task, but new/better/missing examples or corrections are, of course, welcome !
I just realized that attached PDoc files miss argument list details, so the following line is missing when applying the patch:
- object (Object): The item to be inspected.
I'll create an appropriate Lighthouse page with all these informations ASAP.
section: Languagedirective is optional here for
Object.inspectand should be removed as it's already "inherited" from the
- State changed from port to fixed_in_branch
(from [acf9eea3d4c0c7d4e2d1609e4e500b34e947d021]) doc: Merge/update old Object.inspect doc into source [#118 state:fixed_in_branch] http://github.com/samleb/prototype/commit/acf9eea3d4c0c7d4e2d1609e4...