Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Code review hates {@inheritdoc} #169

Closed
agentrickard opened this issue Sep 14, 2021 · 0 comments
Closed

Code review hates {@inheritdoc} #169

agentrickard opened this issue Sep 14, 2021 · 0 comments

Comments

@agentrickard
Copy link
Contributor

We seems to be using the latest versions of Coder and PHP_CodeSniffer and yet...

Code:

  /**
   * {inheritdoc}
   */
  public static function getCacheContexts() {
    return ['cookies:' . AuthenticationInterface::ROLE_COOKIE_NAME];
  }

Test result:

     [echo] $> vendor/bin/phpcs --standard=/var/www/html/vendor/drupal/coder/coder_sniffer/Drupal/ruleset.xml --extensions=php,module,inc,install,test,profile,theme,info,yml web/modules/custom web/themes/custom/tc_theme/tc_theme.theme
     [exec] 
     [exec] FILE: /var/www/html/web/modules/custom/tcauthentication/src/AuthenticationBase.php
     [exec] ----------------------------------------------------------------------------------
     [exec] FOUND 8 ERRORS AFFECTING 4 LINES
     [exec] ----------------------------------------------------------------------------------
     [exec]   76 | ERROR | Doc comment short description must start with a capital letter
     [exec]   76 | ERROR | Doc comment short description must end with a full stop
     [exec]   83 | ERROR | Doc comment short description must start with a capital letter
     [exec]   83 | ERROR | Doc comment short description must end with a full stop
     [exec]  106 | ERROR | Doc comment short description must start with a capital letter
     [exec]  106 | ERROR | Doc comment short description must end with a full stop
     [exec]  115 | ERROR | Doc comment short description must start with a capital letter
     [exec]  115 | ERROR | Doc comment short description must end with a full stop
     [exec] ----------------------------------------------------------------------------------
     [exec] 
     [exec] Time: 

References :

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant