API page: http://api.drupal.org/api/drupal/developer%21topics%21forms_api_referenc...

It says: "Description: Indicates whether or not button should submit the form."

But should say something along the lines of: "Description: Indicates whether or not the submit handler should be run when the form is submitted using this button."

"submit the form" means: Send the webserver a request.
Which is done whether or not #executes_submit_callback is TRUE or FALSE.

CommentFileSizeAuthor
#7 1889030-5-sandykadam-fixed-execute-submit-callback-documentation.patch689 bytessandykadam
#4 1889030-1-sandykadam-fixed-execute-submit-callback-description.patch688 bytessandykadam

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Project: Drupal core » Documentation
Version: 7.x-dev »
Component: documentation » API documentation files
Issue tags: +FAPI reference

Thanks! Moving to the Documentation project, since the form API reference is in that git repository.

dalinian’s picture

dalinian commented

Wow a year later and still hasn't been changed?

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented

If you would like to make a patch, that would be welcome. No one likes to edit this particular document, so there are a ton of issues and no one makes the patches.

Drupal is a volunteer project. Complaining doesn't really help; doing something does. Thanks!

sandykadam’s picture

sandykadam commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new 1889030-1-sandykadam-fixed-execute-submit-callback-description.patch688 bytes

Fixed the description in documentation

jhodgdon’s picture

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

Thanks for the patch!

But I don't think this description is quite correct. The text should only refer to the button where #executes_submit_callback is defined, not "any button".

sandykadam’s picture

sandykadam commented
Assigned: Unassigned » sandykadam
sandykadam’s picture

sandykadam commented
Status: Needs work » Needs review
StatusFileSize
new 1889030-5-sandykadam-fixed-execute-submit-callback-documentation.patch689 bytes

@jhodgdon Fixed the patch as per your suggestion.

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Reviewed & tested by the community

Thanks, that looks good!

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Reviewed & tested by the community » Fixed

Thanks again! Committed to the 6.x, 7.x, and 8.x versions of the form API reference.

Status: Fixed » Closed (fixed)

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