#1726: Missing POD in .pmc files (and a couple of others)
------------------------------+---------------------------------------------
Reporter: mikehh | Owner: jkeenan
Type: todo | Status: assigned
Priority: normal | Milestone:
Component: coding_standards | Version: trunk
Severity: medium | Keywords:
Lang: | Patch: applied
Platform: |
------------------------------+---------------------------------------------
Comment(by jkeenan):
mikehh:
I believe that all of the files cited now have POD `=item` markers, so
documentors will know where to insert the documentation.
I have written to about 10 of our contributors asking them to add function
documentation to files which (per `svn annotate`) they have previously
worked on. NotFound++ for responding promptly to my requests on two
separate files.
As mentioned on IRC, ''t/codingstd/pmc_docs.t'' is an imperfect tool.
(I'd give it a `B-`.) It has problems with function signatures that are
long (>80? >100?) characters. So on some files where I have inserted POD
formating markers, the tool still rates those functions as `missing`
rather than `boilerplate only`. Perhaps this is because I had to break
some of those `=item` lines so that the file could pass the linelength
standard.
But we don't need to bother with all that until the release is out the
door.
Thank you very much.
kid51
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1726#comment:11>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
