-
Notifications
You must be signed in to change notification settings - Fork 3
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
chore(sdk): Add xml doc to nuget package #1979
chore(sdk): Add xml doc to nuget package #1979
Conversation
📝 WalkthroughWalkthroughThe changes modify the project's configuration file to enable XML documentation generation and adjust warning suppression settings. Specifically, the project file is updated to include the Changes
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj (1)
13-13
: XML Documentation Generation EnabledThe addition of
<GenerateDocumentationFile>true</GenerateDocumentationFile>
is an excellent enhancement as it ensures that XML documentation is generated for the project. This can greatly aid consumers of the NuGet package by providing context-sensitive help in IDEs.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj
(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
- GitHub Check: Dry run deploy apps / Deploy job sync-resource-policy-information-job to test
- GitHub Check: build / build-and-test
🔇 Additional comments (1)
src/Digdir.Library.Dialogporten.WebApiClient/Digdir.Library.Dialogporten.WebApiClient.csproj (1)
14-14
: Warning Suppression UpdateAppending warnings
1591
and1573
to the<NoWarn>
list helps reduce build noise from missing XML comments on public APIs. Ensure that suppressing these warnings aligns with your quality standards and that critical documentation warnings aren’t inadvertently hidden.
No description provided.