question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add option to ignore documentation errors on internal members and types

See original GitHub issue

The documentation checkers are really useful for ensure consistency and completeness of XML doc for later generating API reference documentation. However if you put a <summary> tag on an internal member for your own sake, but don’t follow all the rules for documenting the entire member as the rules dictate, you get a lot of warnings.

Most of the warnings aren’t really that important for internal documentation, as most of it pertain to generating API doc. I’d like to be able to turn off the documentation checks for anything not public. Or a general pattern to set the global suppression of a rule to only apply to public/internal/etc. (as long as we all promise not to misuse them 😄 )

Issue Analytics

  • State:open
  • Created 6 years ago
  • Reactions:2
  • Comments:16 (9 by maintainers)

github_iconTop GitHub Comments

1reaction
sharwellcommented, Jun 24, 2017

@dotMorten This should be substantially improved in today’s release (1.1.0-beta004)

1reaction
sharwellcommented, Jun 20, 2017

@dotMorten @m-akinc I created pull request #2447 to fix the behavior of SA1604, SA1611, SA1615, and SA1618.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Missing XML comment for publicly visible type or member
Disable XML documentation: Right Click on your Project -> Properties -> 'Build' tab -> uncheck XML Documentation File. · Sit and write the ......
Read more >
Common issues and solutions - mypy 1.5.1 documentation
You can use # type: ignore[override] to silence the error. Add it to the line that generates the error, if you decide that...
Read more >
Solution-wide analysis | ReSharper Documentation
In the Errors/Warnings in Solution window select a discovered problem or, if you want to ignore all issues in a specific file, select...
Read more >
Suppress code analysis warnings - .NET
Learn the different ways you can suppress .NET code analysis violations.
Read more >
Warning control — Python 3.11.4 documentation
The warnings filter controls whether warnings are ignored, displayed, or turned into errors (raising an exception). Conceptually, the warnings filter maintains ...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found