API page: https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...

The description includes the following sentence:
"See \Drupal\Core\Form\FormState::$internalStorage for documentation of the available flags."

But FormState class does not have property $internalStorage.
See
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...

Perhaps this sentence should be written like:
"See \Drupal\Core\Form\FormState for documentation of the available flags."

Additional info:

This issue is also actual for previous (8.0.x - 8.5.x) versions.

See API pages:
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...
https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo...

CommentFileSizeAuthor
#4 FormStateInterface-documentation-update-2950630-4.patch865 bytesmsankhala
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

wombatbuddy created an issue. See original summary.

cilefen’s picture

cilefen CreditAttribution: cilefen as a volunteer commented
Issue tags: -developer +Novice
msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
Assigned: Unassigned » msankhala
msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
Status: Active » Needs review
FileSize
FormStateInterface-documentation-update-2950630-4.patch865 bytes
longwave’s picture

longwave
he/him
Primary language English
Location UK
CreditAttribution: longwave as a volunteer commented
Status: Needs review » Reviewed & tested by the community

Looks good.

alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
CreditAttribution: alexpott at Acro Commerce, Thunder commented
Status: Reviewed & tested by the community » Fixed

Committed and pushed b8704f830a to 8.6.x and 6e7c2fa390 to 8.5.x. Thanks!

I was going to suggest we add an @see but looking at https://api.drupal.org/api/drupal/core%21lib%21Drupal%21Core%21Form%21Fo... that doesn't seem necessary api.d.o makes a link from fully qualified class names. Nice.

Credited @wombatbuddy for creating the issue.

  • alexpott committed b8704f8 on 8.6.x 
    Issue #2950630 by msankhala, wombatbuddy: The description of the...

  • alexpott committed 6e7c2fa on 8.5.x 
    Issue #2950630 by msankhala, wombatbuddy: The description of the...
msankhala’s picture

msankhala CreditAttribution: msankhala as a volunteer and at Srijan | A Material+ Company commented
Assigned: msankhala » Unassigned

Status: Fixed » Closed (fixed)

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