Problem/Motivation

  • BatchStorageInterface::delete() talks about loading
  • BatchStorageInterface does not have a one-line description at all ... where it is used

Proposed resolution

Remaining tasks

User interface changes

API changes

Beta phase evaluation

Reference: https://www.drupal.org/core/beta-changes
Issue category Bug
Issue priority Major because documentation is incomplete/incorrect
Unfrozen changes Unfrozen because it only changes API documentation
Prioritized changes The main goal of this issue is documentation
CommentFileSizeAuthor
#2 batch-storage-interface-docs-2380377-02.patch652 bytesjhedstrom

Comments

jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Priority: Minor » Major

An interface that is completely missing documentation is a violation of the Documentation Gate. It should never have been committed to Core. So this is not actually a minor bug. An interface without proper documentation is not good.

jhedstrom’s picture

jhedstrom
Primary language English
Location Portland, OR
commented
Issue summary: View changes
Status: Active » Needs review
StatusFileSize
new batch-storage-interface-docs-2380377-02.patch652 bytes

Adds a docblock for the interface, and fixes the description of the ::delete() method.

jhedstrom’s picture

jhedstrom
Primary language English
Location Portland, OR
commented
Issue summary: View changes
jhodgdon’s picture

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

Looks good, beta eval there, thanks!

alexpott’s picture

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

Committed c39c42c and pushed to 8.0.x. Thanks!

Thanks for adding the beta evaluation for to the issue summary.

  • alexpott committed c39c42c on 8.0.x 
    Issue #2380377 by jhedstrom: Fix BatchStorageInterface::delete

Status: Fixed » Closed (fixed)

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