The method says "Overrides Drupal\Core\Queue\System::claimItem()." but the class it actually extends is the DatabaseQueue class.

Quick beta eval: This is just API docs.

CommentFileSizeAuthor
#7 2501685-batch-claimitem-wrong-docs.patch7.05 KBdave reid
#6 2501685-batch-claimitem-wrong-docs.patch7.07 KBdave reid
#4 2501685-batch-claimitem-wrong-docs.patch1.34 KBdave reid
#1 2501685-batch-claimitem-wrong-docs.patch690 bytesdave reid

Comments

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Title: DatabaseQueue::claimItem() contains wrong class in documentation » Batch::claimItem() contains wrong class in documentation
Status: Active » Needs review
StatusFileSize
new 2501685-batch-claimitem-wrong-docs.patch690 bytes
dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Component: base system » documentation
jhodgdon’s picture

jhodgdon
she/her
Primary language English
commented
Status: Needs review » Needs work

Thanks for the patch!

When referring to a class in API doc blocks, always include the namespace (as is done here), starting with a \ (not done here). So this needs a quick edit.

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
Status: Needs work » Needs review
StatusFileSize
new 2501685-batch-claimitem-wrong-docs.patch1.34 KB

Fair enough, I get to fix more!

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented

Oof:

davereid@Corsair250D /var/www/drupal8.dev (8.0.x✓)$ git grep '* Overrides'
core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:   * Overrides Entity::__construct().
core/lib/Drupal/Core/Config/Entity/ConfigEntityBase.php:   * Overrides Entity::isNew().
core/lib/Drupal/Core/Config/InstallStorage.php:   * Overrides Drupal\Core\Config\FileStorage::getFilePath().
core/lib/Drupal/Core/Config/InstallStorage.php:   * Overrides Drupal\Core\Config\FileStorage::write().
core/lib/Drupal/Core/Config/InstallStorage.php:   * Overrides Drupal\Core\Config\FileStorage::delete().
core/lib/Drupal/Core/Config/InstallStorage.php:   * Overrides Drupal\Core\Config\FileStorage::rename().
core/lib/Drupal/Core/Config/InstallStorage.php:   * Overrides Drupal\Core\Config\FileStorage::deleteAll().
core/lib/Drupal/Core/Database/Driver/pgsql/Select.php:   * Overrides SelectQuery::orderBy().
core/lib/Drupal/Core/Datetime/DrupalDateTime.php:   * Overrides prepareTimezone().
core/lib/Drupal/Core/Datetime/DrupalDateTime.php:   * Overrides format().
core/lib/Drupal/Core/DependencyInjection/ContainerBuilder.php:   * Overrides Symfony\Component\DependencyInjection\ContainerBuilder::set().
core/lib/Drupal/Core/Entity/ContentEntityBase.php:   * Overrides Entity::__construct().
core/lib/Drupal/Core/Entity/ContentEntityBase.php:   * Overrides Entity::createDuplicate().
core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php:   * Overrides Constraint::getDefaultOption().
core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/BundleConstraint.php:   * Overrides Constraint::getRequiredOptions().
core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php:   * Overrides Constraint::getDefaultOption().
core/lib/Drupal/Core/Entity/Plugin/Validation/Constraint/EntityTypeConstraint.php:   * Overrides Constraint::getRequiredOptions().
core/lib/Drupal/Core/Field/FormatterPluginManager.php:   * Overrides PluginManagerBase::getInstance().
core/lib/Drupal/Core/Field/WidgetPluginManager.php:   * Overrides PluginManagerBase::getInstance().
core/lib/Drupal/Core/FileTransfer/FTP.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::__construct().
core/lib/Drupal/Core/FileTransfer/FTP.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::factory().
core/lib/Drupal/Core/FileTransfer/FTP.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::getSettingsForm().
core/lib/Drupal/Core/FileTransfer/Local.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::factory().
core/lib/Drupal/Core/FileTransfer/SSH.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::__construct().
core/lib/Drupal/Core/FileTransfer/SSH.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::factory().
core/lib/Drupal/Core/FileTransfer/SSH.php:   * Overrides Drupal\Core\FileTransfer\FileTransfer::getSettingsForm().
core/lib/Drupal/Core/KeyValueStore/DatabaseStorage.php:   * Overrides Drupal\Core\KeyValueStore\StorageBase::__construct().
core/lib/Drupal/Core/KeyValueStore/DatabaseStorageExpirable.php:   * Overrides Drupal\Core\KeyValueStore\StorageBase::__construct().
core/lib/Drupal/Core/Mail/MailManager.php:   * Overrides PluginManagerBase::getInstance().
core/lib/Drupal/Core/Queue/Batch.php:   * Overrides Drupal\Core\Queue\System::claimItem().
core/lib/Drupal/Core/Queue/BatchMemory.php:   * Overrides Drupal\Core\Queue\Memory::claimItem().
core/lib/Drupal/Core/Routing/NullGenerator.php:   * Overrides Drupal\Core\Routing\UrlGenerator::setContext();
core/lib/Drupal/Core/Routing/NullGenerator.php:   * Overrides Drupal\Core\Routing\UrlGenerator::processPath().
core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php:   * Overrides TypedData::getValue().
core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php:   * Overrides TypedData::setValue().
core/lib/Drupal/Core/TypedData/Plugin/DataType/BinaryData.php:   * Overrides TypedData::getString().
core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php:   * Overrides TypedData::getValue().
core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php:   * Overrides TypedData::setValue().
core/lib/Drupal/Core/TypedData/Plugin/DataType/Language.php:   * Overrides TypedData::getString().
core/lib/Drupal/Core/Updater/Module.php:   * Overrides Drupal\Core\Updater\Updater::postInstallTasks().
dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
StatusFileSize
new 2501685-batch-claimitem-wrong-docs.patch7.07 KB

Fixes all namespace usages in core/lib/Drupal/Core/Queue/*

dave reid’s picture

dave reid
he/him
Primary language English
Location Nebraska USA
commented
StatusFileSize
new 2501685-batch-claimitem-wrong-docs.patch7.05 KB

{@inheritdoc} not {@inheritdocs}

The last submitted patch, 4: 2501685-batch-claimitem-wrong-docs.patch, failed testing.

The last submitted patch, 6: 2501685-batch-claimitem-wrong-docs.patch, failed testing.

jhodgdon’s picture

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

Everything looks right to me in this patch. Thanks!

Quick beta eval: This is just API docs.

alexpott’s picture

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

Committed 02d1a4d and pushed to 8.0.x. Thanks!

Thanks for the quick beta eval :)

  • alexpott committed 02d1a4d on 8.0.x 
    Issue #2501685 by Dave Reid: Batch::claimItem() contains wrong class in...

Status: Fixed » Closed (fixed)

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