Problem/Motivation

The documentation of the constructor in ViewsArgumentDefault plugins currently mentions 'Constructs a new Date instance.'. It should be 'Constructs a new [current class] instance.

Abbreviated beta eval: This is a small, unfrozen, documentation bug fix.

CommentFileSizeAuthor
#4 constructor_documentation-2411303-4.patch2.05 KBnils.destoop
#1 constructor_documentation-2411303-1.patch2.11 KBnils.destoop
Support from Acquia helps fund testing for Drupal Acquia logo

Comments

nils.destoop’s picture

nils.destoop CreditAttribution: nils.destoop commented
Status: Active » Needs review
FileSize
constructor_documentation-2411303-1.patch2.11 KB

Attached a patch that sets the correct doc for every class.

nils.destoop’s picture

nils.destoop CreditAttribution: nils.destoop commented
Component: views.module » documentation
jhodgdon’s picture

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

Looks good, except:

+++ b/core/modules/taxonomy/src/Plugin/views/argument_default/Tid.php
@@ -38,7 +38,6 @@ class Tid extends ArgumentDefaultPluginBase implements CacheablePluginInterface
   protected $routeMatch;
 
   /**
-   * Constructs a new Date instance.
    * The vocary storage.
    *
    * @var \Drupal\taxonomy\VocabularyStorageInterface.

What is "vocary", should that be vocabulary? Can you fix that, even though it was not introduced by your patch? Thanks!

nils.destoop’s picture

nils.destoop CreditAttribution: nils.destoop commented
Status: Needs work » Needs review
FileSize
constructor_documentation-2411303-4.patch2.05 KB

An updated patch that also replaces vocary.

jhodgdon’s picture

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

Thanks, looks good! (adding beta eval to issue summary)

alexpott’s picture

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

Committed 157df3f and pushed to 8.0.x. Thanks!

Thanks for adding the beta evaluation to the issue summary.

  • alexpott committed 157df3f on 8.0.x 
    Issue #2411303 by zuuperman: Documentation of ViewsArgumentDefault...

Status: Fixed » Closed (fixed)

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