Skip to content

build: ship XML docs in the package - #3

Merged
sebgod merged 1 commit into
mainfrom
chore/ship-xml-docs
Oct 14, 2026
Merged

sebgod merged 1 commit into
mainfrom
chore/ship-xml-docs

Conversation

@sebgod

@sebgod sebgod commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

Turns on GenerateDocumentationFile in Directory.Build.props so the package ships its /// comments and consumers get IntelliSense. Until now no SharpAstro package shipped XML docs.

  • Keyed on the project name (not *.Tests) rather than IsPackable, which test projects set in their own csproj, after the props file is read.
  • CS1591 (public member without a comment) and CS1573 (a parameter without a <param> when its siblings have one) are silenced: the point is to ship the docs that exist, not to demand them everywhere. Broken crefs and paramrefs still warn.

The Release build has no doc warnings.

🤖 Generated with Claude Code

https://claude.ai/code/session_01RPZU4uiM2Z5d4NWmzLqnJv

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01KyLMW81KxVvWKTFU1iDYFo
@sebgod
sebgod merged commit ea2de1d into main Oct 14, 2026
2 checks passed
@sebgod
sebgod deleted the chore/ship-xml-docs branch October 14, 2026 00:22
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.

1 participant