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

Bugfixes in KdocComments rule #968

Merged
merged 6 commits into from
Jul 8, 2021
Merged

Bugfixes in KdocComments rule #968

merged 6 commits into from
Jul 8, 2021

Conversation

petertrr
Copy link
Member

@petertrr petertrr commented Jul 6, 2021

What's done:

  • Improved logic for merging local and class kdocs of properties
  • Improved warning texts in some cases
  • Updated diff generator in Test Framework

TODO:

  • Before merging, regenerate docs to add the new warning

This pull request closes #964

petertrr added 4 commits July 6, 2021 16:45
### What's done:
* Improved logic for merging local and class kdocs of properties
### What's done:
* Improved warnings
### What's done:
* Improved warnings
@petertrr petertrr added this to the 1.0.0 milestone Jul 7, 2021
@codecov
Copy link

codecov bot commented Jul 7, 2021

Codecov Report

Merging #968 (2be64a2) into master (5dd4574) will decrease coverage by 0.02%.
The diff coverage is 79.31%.

Impacted file tree graph

@@             Coverage Diff              @@
##             master     #968      +/-   ##
============================================
- Coverage     83.89%   83.86%   -0.03%     
- Complexity     2396     2399       +3     
============================================
  Files           101      101              
  Lines          6054     6063       +9     
  Branches       1789     1790       +1     
============================================
+ Hits           5079     5085       +6     
- Misses          265      268       +3     
  Partials        710      710              
Flag Coverage Δ
unittests 83.86% <79.31%> (-0.03%) ⬇️

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

Impacted Files Coverage Δ
...diktat/ruleset/rules/chapter2/kdoc/KdocComments.kt 83.91% <77.77%> (-1.27%) ⬇️
...tlin/org/cqfn/diktat/ruleset/constants/Warnings.kt 98.64% <100.00%> (+<0.01%) ⬆️
...tlin/org/cqfn/diktat/ruleset/utils/KotlinParser.kt 89.28% <100.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 5dd4574...2be64a2. Read the comment docs.

@kgevorkyan kgevorkyan marked this pull request as ready for review July 7, 2021 12:43
### What's done:
* fixes after review
Copy link
Member

@kgevorkyan kgevorkyan left a comment

Choose a reason for hiding this comment

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

lgtm

### What's done:
* Updated docs
@petertrr petertrr merged commit 70c5b97 into master Jul 8, 2021
@petertrr petertrr deleted the bugfix/kdocs#964 branch July 8, 2021 11:17
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

Successfully merging this pull request may close these issues.

Kdoc for properties in body of class
2 participants