API page: https://api.drupal.org/api/drupal/includes%21registry.inc/function/_regi...
Enter a descriptive title (above) relating to function _registry_parse_file, then describe the problem you have found:
The function _registry_parse_file(), and various functions up the tree of calling functions, document that they are listing both functions and classes.
However, the function listing was removed from the registry a long time back -- as you can see, this function is only looking for the words "class" and "interface", not "function".
The documentation was never updated, and it should be updated on this function, functions that call it, functions that call those functions, etc. I think there are about 10 or fewer functions that need to be updated this way -- you can trace them on api.drupal.org pretty easily, so I think this is probably a good Novice project.
| Comment | File | Size | Author |
|---|---|---|---|
| #9 | fix-registry-functions-documentation-2051519-9.patch | 1.18 KB | GoddamnNoise |
| #5 | fix-registry-functions-documentation-2051519-5.patch | 775 bytes | GoddamnNoise |
Comments
Comment #1
jhodgdonAlso this topic page needs the same update:
https://api.drupal.org/api/drupal/includes!registry.inc/group/registry/7
Comment #2
GoddamnNoise commentedI could fix that, but how can i update those api pages?. I can't see any edit link on them. Do i need another role on D.O. or more privileges?.
Comment #3
jhodgdonPages on api.drupal.org are generated from comments in the Drupal Core source code. So, to fix them you need to make a patch. See:
https://drupal.org/node/144223 for info on how to find which patch to create and
https://drupal.org/contributor-tasks/create-patch for how to make a patch
Comment #4
GoddamnNoise commentedThanks, I'm on it.
Comment #5
GoddamnNoise commentedI think it's done.
Comment #6
jhodgdonThanks, looks good!
Can you also fix the documentation that says "functions and classes" in the @defgroup header at the top of registry.inc? That is what generates https://api.drupal.org/api/drupal/includes!registry.inc/group/registry/7 (see comment #1).
Also, when you upload a patch, you need to set the status to "Needs review", to alert people that you've added a patch. Thanks!
For extra credit... We normally want documentation lines to be <= 80 characters long, and each function doc header is supposed to start with a one-line summary. So if you feel adventurous, you could fix up the documentation of _registry_parse_files() so it complies with our documentation standards. But since this is Drupal 7 only, this is optional and I would commit the patch without that getting fixed.
Comment #7
GoddamnNoise commentedThanks for your quick and helpful response. Sorry, i forgot to set the status to "Needs review" and the 80 characters limit. I'll fix that and i'll do the other things you've suggested.
Comment #8
jhodgdonThat will be great, thanks!
Comment #9
GoddamnNoise commentedIt's all fixed now. Let me know if there is something that is not ok.
Comment #10
jhodgdonExcellent, thanks! I'll get this committed probably tomorrow.
Comment #11
GoddamnNoise commentedThanks to you for all your help!.
Comment #12
GoddamnNoise commentedComment #14
jhodgdonThanks again! Committed to 7.x.
Incidentally I noticed you had left an extra space at the end of one of the documentation lines -- I fixed that in the commit. If you plan to contribute more patches to Drupal projects, you might want to investigate your editor settings. Most code editors either have a setting to highlight end-of-line extra spaces or remove them.