Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Part of meta-issue #1310084: [meta] API documentation cleanup sprint and continuation of #1355682: Clean up API docs for path module.
This issue is focused on further changes to bring Path 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.
| Comment | File | Size | Author |
|---|---|---|---|
| #1 | 1811948-1-patch-docs.patch | 7.45 KB | Lars Toomre |
Comments
Comment #1
Lars Toomre CreditAttribution: Lars Toomre commentedHere is a patch that has not been tested locally. This is a result of doing a full and detailed read-through of all of the files in the Path module for a API documentation perspective.
In general, this module looks to be in pretty good shape. There were primarily issues in the Test files.
As a side note, I opened #1811958: Missing sniffs for blank lines in class declarations to address the observed problem with missing blank lines after the class declaration and before the closing brace according to http://drupal.org/node/1354#classes. In the meantime, where observed to be missing, I added a blank line before the closing brace of class declaration.
Comment #2
jhodgdonThis is a docs cleanup. Please confine this patch to documentation only, and then I'll be happy to review it.
Comment #3
jhodgdonThese 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!