docs: add XML comments for boolean return of ILogEntryFilter - #5297
#5297docs: add XML comments for boolean return of ILogEntryFilter#5297jamescrosswell merged 3 commits intomaingetsentry/sentry-dotnet:mainfrom docs/extensions-logging-filtersgetsentry/sentry-dotnet:docs/extensions-logging-filtersCopy head branch name to clipboard
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #5297 +/- ##
==========================================
- Coverage 74.13% 74.12% -0.02%
==========================================
Files 508 508
Lines 18320 18320
Branches 3584 3584
==========================================
- Hits 13581 13579 -2
- Misses 3864 3865 +1
- Partials 875 876 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
Flash0ver
left a comment
There was a problem hiding this comment.
question: do we want to mention XML-doc only changes in the CHANGELOG.md?
I could imagine that we don't.
| /// Creates a new instance of <see cref="DelegateLogEntryFilter"/> | ||
| /// </summary> | ||
| /// <param name="filter"></param> | ||
| /// <param name="filter">The filter <see langword="delegate"/>.</param> |
There was a problem hiding this comment.
question: do we want to mention XML-doc only changes in the CHANGELOG.md?
If not - which I can imagine - we should remove the ### Changelog Entry from the PR description, and also add the skip-changelog label.
There was a problem hiding this comment.
this is more of a general question, I realize:
the documentation of Craft mentions:
https://craft.sentry.dev/configuration/#changelog-policies
But we didn't do this before ... so I'm leaning towards not doing it now either.
resolves #5296
Summary
Add missing documentation comments for the
boolreturn value ofSentry.Extensions.LoggingFilter-Option.Remarks
Also fixes a typo.
Changelog Entry
docs: add XML comments for boolean return of
Sentry.Extensions.LoggingFilters