http://api.drupal.org/api/drupal/modules--user--user.module/function/use... should be tagged as a Form builder function.

CommentFileSizeAuthor
#6 drupal-user-login-block-documentation-981330-6.patch562 byteschrisfree
#2 drupal-user-module-981330-2-user-login-block-documentation.patch1005 bytesmlncn
#1 drupal-user-module-981330-1-user-login-block-documentation.patch669 bytesmlncn

Comments

mlncn’s picture

mlncn commented
Component: documentation » user.module
Status: Active » Needs review
StatusFileSize
new drupal-user-module-981330-1-user-login-block-documentation.patch669 bytes

This exciting patch adds a docblock for the user_login_block function, including the @ingroup forms label. Per form documentation, "All modules should declare their form builder functions to be in this group".

mlncn’s picture

mlncn commented
StatusFileSize
new drupal-user-module-981330-2-user-login-block-documentation.patch1005 bytes

Actually, reading the rest of that directive "and each builder function should reference its validate and submit functions using @see." ... here that is for user_login() and user_login_block().

mr.baileys’s picture

mr.baileys
Primary language Dutch
Location 🇧🇪 (Ghent)
commented
Status: Needs review » Needs work 
+++ modules/user/user.module	25 Nov 2010 03:08:29 -0000
@@ -1220,6 +1220,13 @@ function user_user_categories() {
+ * Form builder; the block user login form.
  • The current convention is "Form builder for..." instead of "Form builder;".
  • I would switch the wording: "Form builder for the user login block form" or more verbose, "Form builder for the user login form displayed in a block."

Other than that this looks good.

Powered by Dreditor.

mlncn’s picture

mlncn commented

My usage is copied directly from the user_login form; should i update that to the current convention to keep everything consistent?

mr.baileys’s picture

mr.baileys
Primary language Dutch
Location 🇧🇪 (Ghent)
commented

Yup.

If I understand correctly, the correct approach is to not change existing Doxygen blocks when guidelines change, except when you're making edits to such a block, in which case it's brought back in line with new guidelines in it's entirety.

So in this case both user_login and user_login_block should use the "Form builder for..." form.

chrisfree’s picture

chrisfree commented
Issue summary: View changes
Status: Needs work » Needs review
StatusFileSize
new drupal-user-login-block-documentation-981330-6.patch562 bytes

My first core patch submission! I was digging through the user module trying to sort out another issue and found that this function had no documentation. Here's a patch that, I think follows the proper API documentation standards.

Status: Needs review » Needs work

The last submitted patch, 6: drupal-user-login-block-documentation-981330-6.patch, failed testing.

Status: Needs work » Needs review

chrisfree queued 6: drupal-user-login-block-documentation-981330-6.patch for re-testing.

chrisfree’s picture

chrisfree commented
Component: user.module » documentation
cilefen’s picture

cilefen commented
Component: documentation » user.module
Issue tags: +Documentation

I think we usually tag it this way, but it may not matter.

chrisfree’s picture

chrisfree commented

@cilefen - ahhh! Thanks for the tip.

chrisfree’s picture

chrisfree commented

Bump.

chrisfree’s picture

chrisfree commented

Anyone have time to review this?

Status: Needs review » Closed (outdated)

Automatically closed because Drupal 7 security and bugfix support has ended as of 5 January 2025. If the issue verifiably applies to later versions, please reopen with details and update the version.