Refactors and warning for unlinked manuals#57
Draft
saecki wants to merge 5 commits intointegration-testsfrom
Draft
Refactors and warning for unlinked manuals#57saecki wants to merge 5 commits intointegration-testsfrom
saecki wants to merge 5 commits intointegration-testsfrom
Conversation
47ee740 to
0e822d4
Compare
6df53d7 to
112e149
Compare
112e149 to
b51d628
Compare
Member
Author
|
I've rebased onto the |
elegaanz
reviewed
Apr 14, 2026
Member
elegaanz
left a comment
There was a problem hiding this comment.
Thank you so much for that PR, the code definitely looks much better now and will be much more pleasant to work with.
5c3747c to
025d5db
Compare
025d5db to
5b350cd
Compare
5b350cd to
2d2590e
Compare
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.
Closes #50
Initially I just wanted to implement the warning for unlinked manuals/docs, which needs both information from the manifest and the readme. Looking at the code, I thought I'd just refactor the manifest and readme checks to generate output. That got a bit out of hand, and turned into quite large changes 😅
The fundamental refactors are:
PackagePathstruct that allows both retrieving the full path and the path relative to the package directory. This cleared things up quite a bit for me, because previously it was a little bit of a guessing game if aPathwas relative or not.Spannedstruct that wraps a value and associates it with aRange<usize>, which is extensively used when parsing the TOML manifest.I still think these refactors are worth while, and allow to more easily add more complex checks in the future.