Documentation for on403 function in Http4xxController.php file was wrong. It's showing

A render array containing the message to display for 404 pages.

Here the 404 should be changed to 403 because the function name is on403.

CommentFileSizeAuthor
#2 fixed-documentation-error-for-on403-function-in-Http4xxController-file-2575967-2.patch580 bytesrashidkhan
Documentation bug for Http4xxController.png6.96 KBrashidkhan
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

rashidkhan created an issue. See original summary.

rashidkhan’s picture

rashidkhan CreditAttribution: rashidkhan as a volunteer commented
FileSize
fixed-documentation-error-for-on403-function-in-Http4xxController-file-2575967-2.patch580 bytes

Fixed the function documentation for on403() function in Http4xxController file in Core/modules/system/src/Controller/Http4xxController.php file.

rashidkhan’s picture

rashidkhan CreditAttribution: rashidkhan as a volunteer commented
Status: Active » Needs review

Version: 8.0.x-dev » 8.1.x-dev

Drupal 8.0.6 was released on April 6 and is the final bugfix release for the Drupal 8.0.x series. Drupal 8.0.x will not receive any further development aside from security fixes. Drupal 8.1.0-rc1 is now available and sites should prepare to update to 8.1.0.

Bug reports should be targeted against the 8.1.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.2.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.1.x-dev » 8.2.x-dev

Drupal 8.1.9 was released on September 7 and is the final bugfix release for the Drupal 8.1.x series. Drupal 8.1.x will not receive any further development aside from security fixes. Drupal 8.2.0-rc1 is now available and sites should prepare to upgrade to 8.2.0.

Bug reports should be targeted against the 8.2.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.3.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

Version: 8.2.x-dev » 8.3.x-dev

Drupal 8.2.6 was released on February 1, 2017 and is the final full bugfix release for the Drupal 8.2.x series. Drupal 8.2.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.3.0 on April 5, 2017. (Drupal 8.3.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.3.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.4.x-dev branch. For more information see the Drupal 8 minor version schedule and the Allowed changes during the Drupal 8 release cycle.

mpdonadio’s picture

mpdonadio
he/him
Primary language English
Location Philadelphia/PA/USA (UTC-5)
CreditAttribution: mpdonadio at DiD Agency commented
Version: 8.3.x-dev » 8.4.x-dev
Component: system.module » documentation
Category: Task » Bug report
Status: Needs review » Reviewed & tested by the community

Looks like this still applies to 8.3.x and 8.4.x (`git apply --check` worked). And incorrect documentation is a bug per:

Incorrect or misleading documentation

But, yeah, this is minor.

xjm’s picture

xjm
she/her
Primary language English
CreditAttribution: xjm at Acquia commented
Version: 8.4.x-dev » 8.3.x-dev

Straightforward code documentation improvements can always go into any patch release, alpha, beta, or RC, so please always file them against the production branch (currently 8.3.x). Thanks!

  • cilefen committed ed9c8e0 on 8.4.x 
    Issue #2575967 by rashidkhan, mpdonadio: Documentation for on403...

  • cilefen committed 1ef7780 on 8.3.x 
    Issue #2575967 by rashidkhan, mpdonadio: Documentation for on403...
cilefen’s picture

cilefen CreditAttribution: cilefen commented
Status: Reviewed & tested by the community » Fixed

Thank you! I committed this to 8.4.x and cherry-picked it to 8.3.x.

Status: Fixed » Closed (fixed)

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