A few FunctionComment Rules removed#1064
Conversation
Codecov Report
@@ Coverage Diff @@
## 8.x-4.x #1064 +/- ##
=============================================
- Coverage 50.38% 49.89% -0.50%
Complexity 683 683
=============================================
Files 118 118
Lines 1820 1820
=============================================
- Hits 917 908 -9
- Misses 903 912 +9
Continue to review full report at Codecov.
|
rthideaway
left a comment
rthideaway
left a comment
There was a problem hiding this comment.
let's adapt method comments
| * @param \Drupal\Core\Cache\Context\CacheContextsManager $contextsManager | ||
| * @param \Drupal\Core\Cache\CacheBackendInterface $resultCacheBackend | ||
| * @param \Drupal\Core\Extension\ModuleHandlerInterface $moduleHandler | ||
| * The module handler. |
There was a problem hiding this comment.
The module handler. comment is describing $moduleHandler parameter, let's move it under it.
|
|
||
| /** | ||
| * @cover queryMap::resolve | ||
| */ |
There was a problem hiding this comment.
@cover annotation says which part of the code is covered by the tests in the current method. We shouldn't use it here. Here we are fixing Drupal.Commenting.FunctionComment.Missing rule which should be fixed by commenting the method instead. Let's just use:
/**
* Map between persisted query IDs and corresponding GraphQL queries.
*/
|
|
||
| /** | ||
| * @cover queryMap::resolve | ||
| */ |
There was a problem hiding this comment.
same comment here as it's the same map
|
|
||
| /** | ||
| * @cover queryMap::resolve | ||
| */ |
There was a problem hiding this comment.
same comment here as it's the same map
|
|
||
| /** | ||
| * @covers \Drupal\graphql\Plugin\GraphQL\DataProducer\String\Uppercase::resolve | ||
| */ |
There was a problem hiding this comment.
method is testing upper case GraphQL data producer, let's change the comment to:
/**
* Tests the upper case data producer.
*/
| /** | ||
| * @cover EntityUuidBufferTest::resolve | ||
| */ | ||
| public function testEntityUuidBuffer() { |
There was a problem hiding this comment.
/**
* Tests the entity UUID buffer.
*/
|
|
||
| /** | ||
| * @cover InvalidPayloadTest::resolve | ||
| */ |
There was a problem hiding this comment.
/**
- Tests the empty payload.
*/
|
|
||
| /** | ||
| * @cover InvalidPayloadTest::setUp | ||
| */ |
|
|
||
| /** | ||
| * @cover UserPermissionsContextTest::resolve | ||
| */ |
|
|
||
| /** | ||
| * @covers ::defaultValue | ||
| */ |
There was a problem hiding this comment.
/**
* Tests the composite default value resolver.
*/
|
@Dylan203 travis build failed, there is one leftover cs violation, let's fix that and then we're good to go |
2 participants
exclude name="Drupal.Commenting.FunctionComment.ReturnCommentIndentation"
exclude name="Drupal.Commenting.FunctionComment.ParamNameNoMatch"
exclude name="Drupal.Commenting.FunctionComment.ParamMissingDefinition"
exclude name="Drupal.Commenting.FunctionComment.ParamCommentIndentation"
exclude name="Drupal.Commenting.FunctionComment.MissingParamName"
exclude name="Drupal.Commenting.FunctionComment.Missing"