Follow-up for #1658846-187: Add language support to node access grants and records

Problem/Motivation

Original node access issue had inline comments using third person verb tense.

Proposed resolution

(Don't change the tense of verbs on functions, those should be third person: Tests...)

Change inside functions the inline comments to be Test ... or Verify that..

Remaining tasks

  • Find in the standard if it really should be Test .. (check 1354). Link to it and quote the section in the motivation part of the issue summary.
  • Decide if this should fix just those introduced in the original issue, or if this should fix more in other places in core.
  • Implement resolution. See contributor task document for creating a patch: http://drupal.org/node/1424598

User interface changes

No UI changes.

API changes

No API changes.

Original report by @xjm

In #1658846-187: Add language support to node access grants and records

+++ b/core/modules/node/lib/Drupal/node/Tests/NodeAccessLanguageTest.phpundefined
@@ -61,31 +47,196 @@ function testNodeAccess() {
+    // Tests that access is not granted if requested with no language.
...
+    // Tests that access is not granted if requested with Hungarian language.
...
+    // Tests that access is not granted if requested with no language.
...
+    // Tests that Hungarian is still not accessible.
...
+    // Tests that Catalan is still not accessible.

These can all be "Test" or "Verify" or something rather than "Tests". (Ditto for similar comments elsewhere.)

CommentFileSizeAuthor
#3 modification_in_grammar-10233741-3.patch9.94 KBjoyceg

Comments

gábor hojtsy’s picture

Do we have standard suggestions for this or is this is an "it feels better"?

joyceg’s picture

Assigned: Unassigned » joyceg

I am working on this issue.

joyceg’s picture

StatusFileSize
new9.94 KB

Adding the patch here.

joyceg’s picture

Status: Active » Needs review
yesct’s picture

Status: Needs review » Postponed
Parent issue: » #2571965: [meta] Fix PHP coding standards in core, stage 1

we should not go through with this, until at least the remaining task that says "find the standard and link to it" is done.

but even more, we have a new strategy for dealing with coding style only changes: #2571965: [meta] Fix PHP coding standards in core, stage 1

postponing this until:
we have a sniffer running automatically, and we can add a rule that checks this particular standard.

for more background, see #1518116-86: [meta] Make Core pass Coder Review

I would also recommend working on bugs (that do not require api changes). tasks can be tricky to know if they are allowed to be committed depending on the phase of the release we are in.

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.

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

Drupal 8.3.6 was released on August 2, 2017 and is the final full bugfix release for the Drupal 8.3.x series. Drupal 8.3.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.4.0 on October 4, 2017. (Drupal 8.4.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.4.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.5.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.4.x-dev » 8.5.x-dev

Drupal 8.4.4 was released on January 3, 2018 and is the final full bugfix release for the Drupal 8.4.x series. Drupal 8.4.x will not receive any further development aside from critical and security fixes. Sites should prepare to update to 8.5.0 on March 7, 2018. (Drupal 8.5.0-alpha1 is available for testing.)

Bug reports should be targeted against the 8.5.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.6.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.5.x-dev » 8.6.x-dev

Drupal 8.5.6 was released on August 1, 2018 and is the final bugfix release for the Drupal 8.5.x series. Drupal 8.5.x will not receive any further development aside from security fixes. Sites should prepare to update to 8.6.0 on September 5, 2018. (Drupal 8.6.0-rc1 is available for testing.)

Bug reports should be targeted against the 8.6.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.7.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.6.x-dev » 8.8.x-dev

Drupal 8.6.x will not receive any further development aside from security fixes. Bug reports should be targeted against the 8.8.x-dev branch from now on, and new development or disruptive changes should be targeted against the 8.9.x-dev branch. For more information see the Drupal 8 and 9 minor version schedule and the Allowed changes during the Drupal 8 and 9 release cycles.

Version: 8.8.x-dev » 8.9.x-dev

Drupal 8.8.7 was released on June 3, 2020 and is the final full bugfix release for the Drupal 8.8.x series. Drupal 8.8.x will not receive any further development aside from security fixes. Sites should prepare to update to Drupal 8.9.0 or Drupal 9.0.0 for ongoing support.

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

Version: 8.9.x-dev » 9.2.x-dev

Drupal 8 is end-of-life as of November 17, 2021. There will not be further changes made to Drupal 8. Bugfixes are now made to the 9.3.x and higher branches only. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

Version: 9.2.x-dev » 9.3.x-dev

Version: 9.3.x-dev » 9.4.x-dev

Drupal 9.3.15 was released on June 1st, 2022 and is the final full bugfix release for the Drupal 9.3.x series. Drupal 9.3.x will not receive any further development aside from security fixes. Drupal 9 bug reports should be targeted for the 9.4.x-dev branch from now on, and new development or disruptive changes should be targeted for the 9.5.x-dev branch. For more information see the Drupal core minor version schedule and the Allowed changes during the Drupal core release cycle.

quietone’s picture

Assigned: joyceg » Unassigned
Status: Postponed » Closed (won't fix)

The Drupal standards for in-line code comments makes no mention of the tense. The tense is only prescribed for most functions in in Drupal API documentation standards for functions/

Therefor I am closing this as won't fix.