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

WildCards Import add documentation #281

Merged
merged 6 commits into from
Sep 22, 2020

Conversation

kentr0w
Copy link
Collaborator

@kentr0w kentr0w commented Sep 14, 2020

What's done:

Added info

### What's done:
    Added info
### What's done:
    Added to yml
@kentr0w kentr0w added the documentation Improvements or additions to documentation label Sep 14, 2020
@kentr0w kentr0w requested a review from petertrr September 14, 2020 11:54
@codecov
Copy link

codecov bot commented Sep 14, 2020

Codecov Report

Merging #281 into master will decrease coverage by 0.88%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #281      +/-   ##
============================================
- Coverage     82.12%   81.23%   -0.89%     
+ Complexity      976      956      -20     
============================================
  Files            50       50              
  Lines          2534     2510      -24     
  Branches        798      782      -16     
============================================
- Hits           2081     2039      -42     
- Misses          169      190      +21     
+ Partials        284      281       -3     
Flag Coverage Δ Complexity Δ
#unittests 81.23% <ø> (-0.89%) 956.00 <ø> (-20.00)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ Complexity Δ
.../ruleset/rules/BracesInConditionalsAndLoopsRule.kt 80.35% <0.00%> (-8.93%) 26.00% <0.00%> (-3.00%)
...diktat/ruleset/rules/comments/HeaderCommentRule.kt 80.00% <0.00%> (-8.61%) 27.00% <0.00%> (-9.00%)
...g/cqfn/diktat/ruleset/utils/FunctonASTNodeUtils.kt 70.37% <0.00%> (-2.71%) 0.00% <0.00%> (ø%)
.../org/cqfn/diktat/ruleset/rules/kdoc/KdocMethods.kt 89.24% <0.00%> (-1.28%) 69.00% <0.00%> (ø%)
...kotlin/org/cqfn/diktat/ruleset/rules/FileNaming.kt 8.69% <0.00%> (-0.83%) 2.00% <0.00%> (ø%)
...g/cqfn/diktat/ruleset/rules/kdoc/KdocFormatting.kt 76.35% <0.00%> (-0.52%) 81.00% <0.00%> (ø%)
...n/kotlin/org/cqfn/diktat/ruleset/rules/SortRule.kt 85.93% <0.00%> (-0.22%) 22.00% <0.00%> (ø%)
...tlin/org/cqfn/diktat/ruleset/constants/Warnings.kt 96.38% <0.00%> (-0.09%) 7.00% <0.00%> (-1.00%)
...cqfn/diktat/ruleset/rules/DiktatRuleSetProvider.kt 97.50% <0.00%> (-0.07%) 3.00% <0.00%> (ø%)
...n/kotlin/org/cqfn/diktat/ruleset/utils/PsiUtils.kt 51.35% <0.00%> (ø) 0.00% <0.00%> (ø%)
... and 21 more

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 3b326ba...719923c. Read the comment docs.

@@ -148,7 +148,8 @@
configuration: {}
- name: FILE_WILDCARD_IMPORTS
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

let's start writing documentation here as comments to yml file

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Member

@orchestr7 orchestr7 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Denis, be quick! Fix it and merge

### What's done:
    Added documentation as comment to yaml
### What's done:
    Added info
Copy link
Collaborator

@aktsay6 aktsay6 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@petertrr petertrr requested a review from orchestr7 September 17, 2020 08:36
@petertrr petertrr merged commit 5f142e4 into master Sep 22, 2020
@petertrr petertrr deleted the bugfix/imports-wildcard-documentation branch September 22, 2020 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants