The class docs for the two password reset forms should differentiate them [#3047699]

/**
 * Provides a user password reset form.
 *
 * @internal
 */
class UserPasswordForm extends FormBase {

and

/**
 * Form controller for the user password forms.
 *
 * @internal
 */
class UserPasswordResetForm extends FormBase {

I can't tell how these two forms are different from the class docs (or the class name, but that's another issue for another day).

One form is the 'send me an email to reset my password'. The other is the 'You have followed the link in the email, now enter a new password'.

Comment	File	Size	Author
#3	the_class_docs_for_the_two_password_reset_forms_should_differentiate_them-3047699-3.patch	940 bytes	alfredofonseca
#3	8.8.x: PHP 7.1 & MySQL 5.7 26,297 pass

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

Comment #1

12 April 2019 at 15:27

joachim created an issue. See original summary.

Comment #2

alfredofonseca CreditAttribution: alfredofonseca as a volunteer commented 12 April 2019 at 20:12

I am working on this on DrupalCon 2019 Seattle

Comment #3

alfredofonseca CreditAttribution: alfredofonseca as a volunteer commented 12 April 2019 at 20:14

File	Size
the_class_docs_for_the_two_password_reset_forms_should_differentiate_them-3047699-3.patch	940 bytes
8.8.x: PHP 7.1 & MySQL 5.7 26,297 pass

Comment #4

alfredofonseca CreditAttribution: alfredofonseca as a volunteer commented 12 April 2019 at 20:17

Status:

Active

» Needs review

Modified:

- core/modules/user/src/Form/UserPasswordForm.php
- core/modules/user/src/Form/UserPasswordResetForm.php

Adding the descriptions requested by @joachim

Comment #5

cosmicdreams CreditAttribution: cosmicdreams at Nerdery commented 12 April 2019 at 20:30

Status:

Needs review

» Reviewed & tested by the community

This is a valid code comment contribution as this might seem clear to someone who has intimate knowledge of the reasons why these different forms were creating initially. The comments assist the developer who inherits the apis and needs to make sense of it all

Comment #6

12 April 2019 at 22:18

webchick committed 1c35ead on 8.8.x

Issue #3047699 by alfredofonseca, joachim, cosmicdreams: The class docs...

Comment #7

12 April 2019 at 22:20

webchick committed 1894d46 on 8.7.x

Issue #3047699 by alfredofonseca, joachim, cosmicdreams: The class docs...

Comment #8

webchick

she/they

English

Vancouver 🇨🇦

CreditAttribution: webchick at Acquia commented 12 April 2019 at 22:21

Status:

Reviewed & tested by the community

» Fixed

LIVE from DrupalCon Seattle!

< Committed <a href="http://cgit.drupalcode.org/drupal/commit/?id=1c35ead">1c35ead</a> and pushed to 8.8.x. Thanks! >
 ------------------------------------------------------------------------------------------------------------------- 
        \   ^__^
         \  (oo)\_______
            (__)\       )\/\
                ||----w |
                ||     ||