Problem/Motivation

Just stumbled accross this wrong documented return value: the doc comment specifies bool as return value for the protected checkFieldAccess() function, but it actually is and must always be an AccessResultInterface instance, as the class immediately calls andIf() on the result of this function call.

Proposed resolution

Update doc.

Remaining tasks

User interface changes

API changes

CommentFileSizeAuthor
#2 fix_checkFieldAccess_doc-2805213-2.patch869 bytesagoradesign

Comments

agoradesign created an issue. See original summary.

agoradesign’s picture

agoradesign commented
Status: Active » Needs review
StatusFileSize
new fix_checkFieldAccess_doc-2805213-2.patch869 bytes
markdorison’s picture

markdorison
he/him
commented
Version: 8.3.x-dev » 8.2.x-dev
Component: entity system » documentation
Status: Needs review » Reviewed & tested by the community
  • Change looks good.
  • Patch applies cleanly.
  • I believe this could be put into 8.2.x.
alexpott’s picture

alexpott
he/they
Primary language English
Location 🇪🇺🌍
commented
Status: Reviewed & tested by the community » Fixed
Issue tags: +rc eligible

Committed and pushed 5681fbe to 8.3.x and 0ae4b86 to 8.2.x. Thanks!

As a docs change this is rc eligible.

  • alexpott committed 5681fbe on 8.3.x 
    Issue #2805213 by agoradesign: Incorrect documentation for...

  • alexpott committed 0ae4b86 on 8.2.x 
    Issue #2805213 by agoradesign: Incorrect documentation for...

Status: Fixed » Closed (fixed)

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