#493: [RFC] - eliminate boilerplate function documentation
--------------------+-------------------------------------------------------
Reporter: coke | Owner: coke
Type: RFC | Status: new
Priority: normal | Milestone: 1.1
Component: docs | Version:
Severity: medium | Keywords:
Lang: | Patch:
Platform: |
--------------------+-------------------------------------------------------
In the beginning (or slightly thereafter) there was a test to insure that
c function documentation existed.
Then, rather than actually add documentation to make the test pass,
placeholder documentation was added in many locations to make the test
pass.
Except now the functions still aren't documented, the test still checks
for missing docs, not boilerplate docs, so you have to resort to searching
for the boilerplate, making the test useless...
Unless I hear a good objection, I'm going to rip out any of the
boilerplate docs so we can start using t/codingstd/c_function_docs.t
again.
FYI: that test is now run as a TODO'd test as part of the normal 'make
codetest'
--
Ticket URL: <https://trac.parrot.org/parrot/ticket/493>
Parrot <https://trac.parrot.org/parrot/>
Parrot Development
_______________________________________________
parrot-tickets mailing list
[email protected]
http://lists.parrot.org/mailman/listinfo/parrot-tickets
