Update docs and verify infrastructure #55
Merged
Conversation
This file contains 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
tcharding
force-pushed
the
02-10-verify
branch
from
8336f71 to
8bbe84b
Compare
|
Ha! 4,000 line diff. This is unreviewable. I rekon you should just trust me that its all docs and tooling related. |
tcharding
force-pushed
the
02-10-verify
branch
from
8bbe84b to
44a6daa
Compare
|
I pulled #56 out of this, they were unrelated. |
Fix cut'n'pasta mistake - used v17 instead of v18.
This is a bug, I noticed the name was wrong. I don't know how we could have caught it mechanically though.
We accidentally called `method::all_methods` twice instead of calling `versioned::all_methods`. This means that the rustdocs method list was not being checked for either missing or additional methods. Fix the bug, luckily for v17 and v18 this introduces no new warnings.
Currently we naively match on `Foo` to see if the re-export exists but this can give a false possitive if eg, `FooBar` exists. Observe that re-exports are always followed by either a `,` or a `}` so we can append these to the regex string.
When I added new methods for v18 I was lazy and put the at the bottom - bad Tobin no biscuit.
Update the `types::v19` rustdocs (the SSOT for the status of v19 support). Add `Version::V19` to the `verify` crate. Verify with `verify v19`.
Update the `types::v20` rustdocs (the SSOT for the status of v20 support). Add `Version::V20` to the `verify` crate. Verify with `verify v20`.
Update the `types::v21` rustdocs (the SSOT for the status of v21 support). Add `Version::V21` to the `verify` crate. Verify with `verify v21`.
Update the `types::v22` rustdocs (the SSOT for the status of v22 support). Add `Version::V22` to the `verify` crate. Verify with `verify v22`.
Update the `types::v23` rustdocs (the SSOT for the status of v23 support). Add `Version::V23` to the `verify` crate. Verify with `verify v23`.
Update the `types::v24` rustdocs (the SSOT for the status of v24 support). Add `Version::V24` to the `verify` crate. Verify with `verify v24`.
Update the `types::v25` rustdocs (the SSOT for the status of v25 support). Add `Version::V25` to the `verify` crate. Verify with `verify v25`.
tcharding
force-pushed
the
02-10-verify
branch
from
44a6daa to
b7dc2e7
Compare
Ooph, that's not good - this claim is false. The PR also fixes the re-exports in version specific modules e.g., I cleaned up and rebased on master. Going to merge now once CI passes. |
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.
For Core versions 19 - 25 inclusive update the rustdocs in
types/src/vxy/mod.rs to match the style we introduced in v17 and v18 already. And add support to theverify` tool to check the work.This is all version upto the latest 3.