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.

Sign up for GitHub

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

Jump to bottom

Relax documentation requirements according to the current settings #2447

Merged
merged 14 commits into from
Jun 20, 2017
Merged

Relax documentation requirements according to the current settings #2447

merged 14 commits into from
Jun 20, 2017

Conversation

sharwell
Copy link
Member

@sharwell sharwell commented Jun 20, 2017 •
edited
Loading

@sharwell sharwell added this to the 1.1.0 Beta 4 milestone Jun 20, 2017
@sharwell sharwell mentioned this pull request Jun 20, 2017
Open
@codecov
Copy link

codecov bot commented Jun 20, 2017 •
edited
Loading

Codecov Report

Merging #2447 into master will increase coverage by 0.05%.
The diff coverage is 100%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #2447      +/-   ##
==========================================
+ Coverage   97.14%   97.19%   +0.05%     
==========================================
  Files         732      732              
  Lines       94114    94538     +424     
  Branches     3449     3452       +3     
==========================================
+ Hits        91424    91889     +465     
+ Misses       1834     1810      -24     
+ Partials      856      839      -17
Impacted Files Coverage Δ
...s/SA1606ElementDocumentationMustHaveSummaryText.cs 100% <ø> (ø) ⬆️
...SA1614ElementParameterDocumentationMustHaveText.cs 100% <ø> (ø) ⬆️
...7PartialElementDocumentationMustHaveSummaryText.cs 89.65% <ø> (ø) ⬆️
...tParameterDocumentationMustDeclareParameterName.cs 96.77% <ø> (ø) ⬆️
...08ElementDocumentationMustNotHaveDefaultSummary.cs 92.85% <ø> (ø) ⬆️
...1616ElementReturnValueDocumentationMustHaveText.cs 100% <ø> (ø) ⬆️
...es/SA1610PropertyDocumentationMustHaveValueText.cs 100% <ø> (ø) ⬆️
...ationRules/PropertySummaryDocumentationAnalyzer.cs 98.97% <ø> (ø) ⬆️
...625ElementDocumentationMustNotBeCopiedAndPasted.cs 98.55% <ø> (ø) ⬆️
...alyzers.Test/DocumentationRules/SA1605UnitTests.cs 100% <100%> (ø) ⬆️
... and 26 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 b371a67...f78d06e. Read the comment docs.

sharwell
sharwell commented Jun 20, 2017
View reviewed changes
...p.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs
{
if (!needsComment)
{
// Omitting documentation for a parameter is allowed for this element.
Copy link
Member Author

Choose a reason for hiding this comment

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

❗️ Missing return statement here

Copy link
Member Author

Choose a reason for hiding this comment

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

➡️ now fixed

@sharwell sharwell self-assigned this Jun 20, 2017
@sharwell sharwell merged commit ca540f2 into DotNetAnalyzers:master Jun 20, 2017
@sharwell sharwell deleted the relax-doc-reqs branch June 20, 2017 18:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees

@sharwell sharwell

Labels
None yet
Projects
None yet
Milestone
1.1.0 Beta 4
Development

Successfully merging this pull request may close these issues.
1 participant
@sharwell