Code review C: documentation drift#139
Merged
Merged
Conversation
docs/getting-started.md: - Prerequisites said '.NET 8.0 or later' but the library multi-targets net462 / netstandard2.0 / net8.0 / net10.0. Rewrote the prereq to spell out the supported runtime matrix (anything supporting .NET Standard 2.0+). CHANGELOG.md: - Added the Keep-a-Changelog footer link references ([Unreleased], [1.1.1], [1.1.0], [1.0.0]) so the version headings link to GitHub compare pages. The DateTime-Extensions canonical CHANGELOG has these and consumers expect them to be navigable.
Contributor
There was a problem hiding this comment.
Pull request overview
Updates documentation to better reflect the library’s actual target/runtime support and to align the changelog with Keep a Changelog’s recommended reference-link footer format.
Changes:
- Updated
docs/getting-started.mdprerequisites to describe the supported runtime matrix (net462 through net10.0). - Added missing compare-link reference definitions to the bottom of
CHANGELOG.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| docs/getting-started.md | Replaces the “.NET 8.0+” prerequisite with a runtime support matrix consistent with the package’s multi-targeting. |
| CHANGELOG.md | Adds Keep-a-Changelog-style footer links for [Unreleased] and version comparisons. |
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
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.
Two doc fixes from the v1.1.1 code review:
docs/getting-started.mdprereq said .NET 8.0 only; library actually targets net462 → net10.0. Rewrote to spell out the runtime matrix.CHANGELOG.mdwas missing the Keep-a-Changelog footer compare-links. Added.Doc-only. Stacked on vNext (PR #129).