Problem/Motivation
Coding standards recommend that the Doxygen header for a core function start with a one-line, one-sentence summary. The function summary for the request_uri()
function violates the standard. As the Druplicon factoid states:
request_uri: [Documented summary is not one line. This is a bug. File a patch!]
Proposed resolution
A patch has been submitted to rewrite the Doxygen header to conform with coding standards.
Remaining tasks
The patch needs to be reviewed, approved, and committed.
User interface changes
None.
API changes
None.
Comment | File | Size | Author |
---|---|---|---|
#4 | request_uri-docs-1283244-1.patch | 1.06 KB | TR |
#2 | request_uri-docs-1283244-1.patch | 1.05 KB | pillarsdotnet |
Comments
Comment #1
pillarsdotnet CreditAttribution: pillarsdotnet commentedTagging...
Comment #2
pillarsdotnet CreditAttribution: pillarsdotnet commentedPatch.
Comment #3
tstoecklerYup, looks good.
Comment #4
TR CreditAttribution: TR commentedRe-rolled to correct grammar in the function description. Changed "Since" to "Because".
Comment #5
TR CreditAttribution: TR commentedcrosspost
Comment #6
oriol_e9gComment #7
oriol_e9gComment #7.0
oriol_e9gStatus update.
Comment #8
millwardesque CreditAttribution: millwardesque commentedLooks good to me.
Comment #9
jhodgdonLooks good to me too! Thanks for patching and reviewing!
One thing: Please don't tag issues "documentation" if they are already in the documentation component -- it's not really necessary. And this needs to be patched in d7 too. :)
Comment #10
pillarsdotnet CreditAttribution: pillarsdotnet commentedSorry; I originally tagged it documentation in the base system component, and then oriol_e9g moved it to the documentation component in #6. Next time that happens, I'll remove the tag. Or would you rather that I had started the issue in the documentation component to begin with? I seem to remember that you preferred otherwise. Is there a how-to for all this?
Comment #10.0
pillarsdotnet CreditAttribution: pillarsdotnet commentedUpdated patch links.
Comment #11
jhodgdonUsually doc-only issues where there is no programming question to be resolved are just in the Doc component.
Comment #12
Dries CreditAttribution: Dries commentedCommitted to 7.x and 8.x. Thanks.
Comment #13.0
(not verified) CreditAttribution: commentedUpdated status.