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.

CommentFileSizeAuthor
#6 color_docs-1808178-6.patch5.6 KBAlbert Volkman
#3 color_docs-1808178-3.patch5.23 KBAlbert Volkman
#1 1808178-1-color-docs.patch534 bytesLars 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
1808178-1-color-docs.patch534 bytes

Attached 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.

Lars Toomre’s picture

Lars Toomre CreditAttribution: Lars Toomre commented
Status: Needs review » Needs work

Changing to right status

Albert Volkman’s picture

Albert Volkman CreditAttribution: Albert Volkman commented
FileSize
color_docs-1808178-3.patch5.23 KB

First pass. There's some params/returns that are missing definitions still (marked with @todos).

no_angel’s picture

no_angel CreditAttribution: no_angel commented
Assigned: Unassigned » no_angel
no_angel’s picture

no_angel CreditAttribution: no_angel commented
Assigned: no_angel » Unassigned

needs work.
needs to be re-assigned to "unassigned"

Albert Volkman’s picture

Albert Volkman CreditAttribution: Albert Volkman commented
Status: Needs work » Needs review
FileSize
color_docs-1808178-6.patch5.6 KB

Here'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.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Needs review » Needs work

Thanks! 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.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes

Updated issue summary.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Issue summary: View changes
Status: Needs work » 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!