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

Enhancement: Enable and configure no_superfluous_phpdoc_tags fixer #215

Merged
merged 2 commits into from Oct 21, 2020

Conversation

localheinz
Copy link
Member

@localheinz localheinz commented Oct 21, 2020

This PR

  • enables and configures the no_superfluous_phpdoc_tags
  • runs make cs

💁‍♂️ For reference, see https://github.com/FriendsOfPHP/PHP-CS-Fixer/tree/v2.16.4#usage:

no_superfluous_phpdoc_tags [@Symfony, @PhpCsFixer]

Removes @param, @return and @var tags that don't provide any useful information.

Configuration options:

  • allow_mixed (bool): whether type mixed without description is allowed (true) or considered superfluous (false); defaults to false
  • allow_unused_params (bool): whether param annotation without actual signature is allowed (true) or considered superfluous (false); defaults to false
  • remove_inheritdoc (bool): remove @inheritDoc tags; defaults to false

@codecov
Copy link

codecov bot commented Oct 21, 2020

Codecov Report

Merging #215 into main will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##                main      #215   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
  Complexity         8         8           
===========================================
  Files              2         2           
  Lines             24        24           
===========================================
  Hits              24        24           
Impacted Files Coverage Δ Complexity Δ
src/Factory.php 100.00% <ø> (ø) 2.00 <0.00> (ø)

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1628c61...e2ff2b3. Read the comment docs.

@ergebnis-bot ergebnis-bot self-assigned this Oct 21, 2020
@ergebnis-bot ergebnis-bot merged commit 309a510 into main Oct 21, 2020
@ergebnis-bot ergebnis-bot deleted the feature/no-superfluous-phpdoc-tags branch October 21, 2020 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants