Contrib.social

document Form API #element_validate callback

Open on Drupal.org →
Created on 3 May 2013, over 11 years ago
Updated 13 March 2023, over 1 year ago

We recently adopted a new standard way to document "callback functions" -- see http://drupal.org/coding-standards/docs#callback-def for the standard and #1250500: [policy adopted; patch done] Find a (standard) way to document callback signatures → for the issue where this was adopted.

The FormAPI #element_validate callback should be documented as part of this.

This involves the following tasks:

- add a definition of the callback to an api.php file
- rewrite the docblock of all #element_validate callback functions & methods:
-- state this is an implementation of the callback
-- remove any parameters
-- preserve description of what the callback accomplishes in the 2nd paragraph of the docblock

This would also require the form API docs at http://api.drupal.org/api/drupal/developer%21topics%21forms_api_referenc... to be changed to refer to the new callback documentation.

<!-- See https://drupal.org/core-mentoring/novice-tasks for tips on identifying novice tasks. Delete or add "Novice" from the Novice? column in the table below as appropriate. Uncomment tasks as the issue advances. Update the Complete? column to indicate when they are done, and maybe reference the comment number where they were done. -->
🐛 Bug report
Status

Needs work

Version

10.1 ✨

Component
Documentation  →

Last updated about 17 hours ago

No maintainer
Created by

🇬🇧United Kingdom joachim

Live updates comments and jobs are added and updated live.
  • Novice

    It would make a good project for someone who is new to the Drupal contribution process. It's preferred over Newbie.

  • Needs backport to D7

    After being applied to the 8.x branch, it should be considered for backport to the 7.x branch. Note: This tag should generally remain even after the backport has been written, approved, and committed.

  • Needs issue summary update

    Issue summaries save everyone time if they are kept up-to-date. See Update issue summary task instructions.

  • Coding standards

    It involves compliance with, or the content of coding standards. Requires broad community agreement.

Sign in to follow issues

Comments & Activities

Not all content is available!

It's likely this issue predates Contrib.social: some issue and comment data are missing.

  • Comment over 1 year ago →
    🇺🇸United States smustgrave

    Seems the issue summary update has not happened yet.

    and in #52 it was noted this needs work also

    Just FYI to help get the message out there.

    Starting March 2023, simple rerolls, rebases, or merges will no longer receive issue credit. Only rerolls that address a merge conflict will be credited, and the merge conflict that was resolved must be documented in the text of an issue comment.
    To receive credit for contributing to this issue, assist with other outstanding tasks or unaddressed feedback.
    See the issue credit guidelines → for more information.

contrib.social Blog FAQ Discussions
Production build 0.71.5 2024