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 #1332580: Clean up API docs for color module.
This issue is focused on further changes to bring Color module closer to D8/D7 documentation standards. This issue, for instance, will ensure that there are no missing @param or @return directives from docblocks.
Comment | File | Size | Author |
---|---|---|---|
#6 | color_docs-1808178-6.patch | 5.6 KB | Albert Volkman |
#3 | color_docs-1808178-3.patch | 5.23 KB | Albert Volkman |
#1 | 1808178-1-color-docs.patch | 534 bytes | Lars Toomre |
Comments
Comment #1
Lars Toomre CreditAttribution: Lars Toomre commentedAttached is an obviously incomplete patch that might be addressed with a complete review of the Color module for compliance with the D8 documentation standards. Others are welcome to expand upon this start towards a complete patch.
Comment #2
Lars Toomre CreditAttribution: Lars Toomre commentedChanging to right status
Comment #3
Albert Volkman CreditAttribution: Albert Volkman commentedFirst pass. There's some params/returns that are missing definitions still (marked with @todos).
Comment #4
no_angel CreditAttribution: no_angel commentedComment #5
no_angel CreditAttribution: no_angel commentedneeds work.
needs to be re-assigned to "unassigned"
Comment #6
Albert Volkman CreditAttribution: Albert Volkman commentedHere's a bit more. I'm not well-versed in image manipulation, so might need some more corrections. Additionally,
_color_hue2rgb()
still needs some documentation.Comment #7
jhodgdonThanks! This will take some time for someone to review (it's not like a patch cleaning up grammar/typos that I can just review/commit, since it's adding documentation that needs to be seriously reviewed for accuracy). Also, there are still @todo messages in the documentation, so it's definitely not ready to be committed yet.
Comment #7.0
jhodgdonUpdated issue summary.
Comment #8
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!