#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):
Replying to [comment:8 plobsing]:
> Replying to [ticket:1726 mikehh]:
> What purpose does documenting these functions, which are little more
than implementation details, with POD serve?
I second mikehh's remarks. Going into this exercise, the overwhelming
majority of `static` functions in the ''.pmc'' files had neither comments
nor POD. There's no point in worrying about signal-to-noise ratios if the
signal is inherently faint.
Let's err on the side of completeness. Once all the functions are
documented, we can revisit the question of the optimum balance between
inline comments and POD.
Thank you very much.
kid51
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/1726#comment:10>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
