Updated: Comment #0

Problem/Motivation

The docblock on \Drupal\node\NodeTypeInterface::isLocked() is Returns a locked state of the type
Lets reword it into something that reads better.

Proposed resolution

Patch

Remaining tasks

Patch
Review

User interface changes

None

API changes

None

Follow-up from #2100397: [meta] Ensure that DX issues identified by a recent review are covered with individual issues.

CommentFileSizeAuthor
#3 doco-islocked-2104353-3.patch534 bytespameeela
#1 doco-islocked-2104353-1.patch523 bytespameeela
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

pameeela’s picture

pameeela CreditAttribution: pameeela commented
Status: Active » Needs review
FileSize
doco-islocked-2104353-1.patch523 bytes

Changes 'Returns a locked state of the type' to 'Whether the node type is locked'

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
CreditAttribution: larowlan commented 
+++ b/core/modules/node/lib/Drupal/node/NodeTypeInterface.php
@@ -27,7 +27,7 @@
+   * Whether the node type is locked.

http://drupal.org/node/1354 says

For most functions (see exceptions below), summary lines must start with a third person singular present tense verb, and they must explain what the function does. Example: "Calculates the maximum weight for a list."

so can we get a verb on the front?

pameeela’s picture

pameeela CreditAttribution: pameeela commented
FileSize
doco-islocked-2104353-3.patch534 bytes

Determines whether the node type is locked

larowlan’s picture

larowlan
Location 🇦🇺🏝.au GMT+10
CreditAttribution: larowlan commented
Status: Needs review » Reviewed & tested by the community

Thanks

jhodgdon’s picture

jhodgdon
she/her
Primary language English
CreditAttribution: jhodgdon commented
Status: Reviewed & tested by the community » Fixed

Thanks! Looks good, committed to 8.x.

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