fix: ship XML docs and a README in the NuGet packages - #64
Merged
Merged
Conversation
Trax.Core and Trax.Core.Analyzers are now packed with the repository README, an accurate description, tags, the project URL and the TraxSharp repository URL, all set once in Directory.Build.props for projects under src/. Trax.Core now generates its XML doc file, so the existing summaries reach IntelliSense; CS1591 stays off for it while undocumented members are burned down, and the four other doc warnings that surfaced (an unresolvable exception cref and an ambiguous Resolve cref) are fixed at the source. Trax.Core.Testing already documented everything and keeps CS1591 on. The deprecated analyzer gets no doc file. No .snupkg is produced: DotNet.ReproducibleBuilds embeds the PDB, with its SourceLink map, in the shipped DLL, so a symbol package would be empty. The README Quick Start now compiles and runs against the current API: a Core-only train puts its services on board with AddServices, since junction constructor arguments come from memory.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
|
This PR is included in version 1.7.5 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Trax.Core and Trax.Core.Analyzers are now packed with the repository README, an accurate description, tags, the project URL and the TraxSharp repository URL, all set once in Directory.Build.props for projects under src/. Trax.Core now generates its XML doc file, so the existing summaries reach IntelliSense; CS1591 stays off for it while undocumented members are burned down, and the four other doc warnings that surfaced (an unresolvable exception cref and an ambiguous Resolve cref) are fixed at the source. Trax.Core.Testing already documented everything and keeps CS1591 on. The deprecated analyzer gets no doc file.
No .snupkg is produced: DotNet.ReproducibleBuilds embeds the PDB, with its SourceLink map, in the shipped DLL, so a symbol package would be empty.
The README Quick Start now compiles and runs against the current API: a Core-only train puts its services on board with AddServices, since junction constructor arguments come from memory.