We have several issues with our documentation that should be fixed.
One of the things we need to fix is:

Summary lines must start with a third person singular present tense verb, and they must explain what the function does. Example: "Calculates the aximum weight for a list."

Furthermore, I just ran phpcs on the codebase (phpcs --standard=~/.composer/vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml . > phpcs-output.txt).
I've attached the output, this should be fixed as well.

Support from Acquia helps fund testing for Drupal Acquia logo

Comments

borisson_ created an issue. See original summary.

borisson_’s picture

Assigned: Unassigned » borisson_

I'm taking a stab at this.

borisson_’s picture

Assigned: borisson_ » Unassigned
Status: Active » Needs review
FileSize
85.33 KB

Fixes most of the docs, fixes al phpcs output, removed some methods that weren't needed.

borisson_’s picture

Status: Needs review » Fixed

  • borisson_ committed a752469 on 8.x-1.x
    Issue #2656748 by borisson_: Fix issues with documentation standards
    

Status: Fixed » Closed (fixed)

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