#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: |
------------------------------+---------------------------------------------
Changes (by jkeenan):
* patch: => applied
Comment:
I have merged the ''tt1726_pmc_pod'' branch into trunk. This adds
''t/codingstd/pmc_docs.t'' which works very much like
''t/codingstd/c_function_docs.t'', ''viz.,'' a `__DATA__` section in the
test file holds a list of ''.pmc'' files which as yet have functions which
are either entirely undocumented ('missing') or which just have POD
`=item` placeholders ('boilerplate').
As time permits, I am going to do an `svn annotate` on these ''.pmc''
files and try to figure out who would be most qualified to write
documentation on particular functions. I will then email the lucky
individuals to request that they write documentation.
Keep your fingers crossed!
(Though the branch has been merged, this ticket will remain open until we
clear up this backlog of missing documentation. Mike, if you would like
to put this list on a wiki page, please go right ahead. I have not yet
made any changes in ''tools/build/headerizer.pl''; those can wait for what
I have to do in TT #1725.)
Thank you very much.
kid51
{{{
$ perl t/harness t/codingstd/pmc_docs.t
t/codingstd/pmc_docs.t .. 1/95
not ok 8 - src/dynpmc/rational.pmc # TODO Missing function docs
not ok 13 - src/pmc/bigint.pmc # TODO Missing function docs
not ok 14 - src/pmc/bignum.pmc # TODO Missing function docs
not ok 17 - src/pmc/callcontext.pmc # TODO Missing function docs
not ok 19 - src/pmc/class.pmc # TODO Missing function docs
not ok 21 - src/pmc/complex.pmc # TODO Missing function docs
not ok 23 - src/pmc/coroutine.pmc # TODO Missing function docs
not ok 26 - src/pmc/eval.pmc # TODO Missing function docs
not ok 34 - src/pmc/fixedintegerarray.pmc # TODO Missing function docs
not ok 40 - src/pmc/hashiterator.pmc # TODO Missing function docs
not ok 42 - src/pmc/imageio.pmc # TODO Missing function docs
not ok 43 - src/pmc/imageiosize.pmc # TODO Missing function docs
not ok 45 - src/pmc/integer.pmc # TODO Missing function docs
not ok 52 - src/pmc/namespace.pmc # TODO Missing function docs
not ok 53 - src/pmc/nci.pmc # TODO Missing function docs
not ok 54 - src/pmc/null.pmc # TODO Missing function docs
not ok 55 - src/pmc/object.pmc # TODO Missing function docs
not ok 58 - src/pmc/orderedhash.pmc # TODO Missing function docs
not ok 60 - src/pmc/packfile.pmc # TODO Missing function docs
not ok 80 - src/pmc/role.pmc # TODO Missing function docs
not ok 90 - src/pmc/sub.pmc # TODO Missing function docs
not ok 92 - src/pmc/threadinterpreter.pmc # TODO Missing function docs
not ok 95 - src/pmc/unmanagedstruct.pmc # TODO Missing function docs
t/codingstd/pmc_docs.t .. ok
}}}
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1726#comment:6>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
