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.

CommentFileSizeAuthor
#4 request_uri-docs-1283244-1.patch1.06 KBtr
#2 request_uri-docs-1283244-1.patch1.05 KBpillarsdotnet

Comments

pillarsdotnet’s picture

pillarsdotnet commented
Issue tags: +Documentation, +Novice

Tagging...

pillarsdotnet’s picture

pillarsdotnet commented
StatusFileSize
new request_uri-docs-1283244-1.patch1.05 KB

Patch.

tstoeckler’s picture

tstoeckler
he/him
Primary language German
Location Essen, Germany
commented
Status: Active » Reviewed & tested by the community

Yup, looks good.

tr’s picture

tr commented
Status: Reviewed & tested by the community » Active
StatusFileSize
new request_uri-docs-1283244-1.patch1.06 KB

Re-rolled to correct grammar in the function description. Changed "Since" to "Because".

tr’s picture

tr commented
Status: Active » Needs review

crosspost

oriol_e9g’s picture

oriol_e9g
Primary language Catalan
Location Barcelona
commented
Component: base system » documentation
Status: Needs review » Reviewed & tested by the community
oriol_e9g’s picture

oriol_e9g
Primary language Catalan
Location Barcelona
commented
Status: Reviewed & tested by the community » Needs review
oriol_e9g’s picture

oriol_e9g
Primary language Catalan
Location Barcelona
commented
Issue summary: View changes

Status update.

millwardesque’s picture

millwardesque commented
Status: Needs review » Reviewed & tested by the community

Looks good to me.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Title: request_uri: [Documented summary is not one line. This is a bug. File a patch!] » request_uri() doc does not conform to standards
Issue tags: -Documentation +Needs backport to D7

Looks 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. :)

pillarsdotnet’s picture

pillarsdotnet commented

One thing: Please don't tag issues "documentation" if they are already in the documentation component -- it's not really necessary.

Sorry; 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?

pillarsdotnet’s picture

pillarsdotnet commented
Issue summary: View changes

Updated patch links.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

Usually doc-only issues where there is no programming question to be resolved are just in the Doc component.

dries’s picture

dries commented
Status: Reviewed & tested by the community » Fixed

Committed to 7.x and 8.x. Thanks.

Automatically closed -- issue fixed for 2 weeks with no activity.

Anonymous’s picture

(not verified) commented
Issue summary: View changes

Updated status.