Part of meta-issue #1310084: [meta] API documentation cleanup sprint and continuation of #1315214: Clean up API docs for the tracker module.

This issue is focused on further changes to bring Tracker module closer to D8/D7 documentation standards. This issue, for instance, will ensure that there are no missing @param or @return directives from docblocks and that the various Test files are in accord with http://drupal.org/node/1354.

CommentFileSizeAuthor
#1 1813272-1-tracker-docs.patch6.71 KBLars Toomre
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Lars Toomre’s picture

Lars Toomre CreditAttribution: Lars Toomre commented
Status: Active » Needs review
FileSize
1813272-1-tracker-docs.patch6.71 KB

Here is a locally untested patch of the results from doing a full read through of this module from a documentation perspective.

Lars Toomre’s picture

Lars Toomre CreditAttribution: Lars Toomre commented

I opened up #1813318: Clean up tests in Tracker module from coding standards perspective to address the companion coding standards review, since there are several problems with regard to that standard which need to be addressed as well.

sun’s picture

sun
Primary language German
Location Karlsruhe
CreditAttribution: sun commented
Component: configuration system » tracker.module
jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes
Status: Needs review » Closed (won't fix)

These issues are a lot of work with very little tangible payoff, so I'm closing the rest of them as "won't fix". Your efforts on working on this issue were appreciated... it was just my fault for starting a task that was very difficult to get right.

Let's instead put our effort into fixing and reviewing documentation that is really unclear and/or wrong, and I hope that the people who worked on these issues are not afraid to jump into a more reasonable issue!