Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Crazy idea: change rustdoc-types versions to match rust compiler #34

Open
cameronelliott opened this issue Sep 19, 2024 · 1 comment
Open

Comments

@cameronelliott
Copy link

First, thanks for making this!!! It's great.

This might be a bad idea, but I am throwing it out anyway.

I recently had to dig in and understand a little about mapping rustdoc-types version to rustc version numbers, as my deserialization was failing.

I wonder if having the rustdoc-types version numbers be equal to the lowest version of the rust-compiler they work on would be useful.
Maybe a table (maybe it already exists?) would be a better approach.
Actually a table in the readme or an <h1> link to a table in the readme for compatibility would be super useful!

Thanks

@aDotInTheVoid
Copy link
Member

aDotInTheVoid commented Sep 19, 2024

I wonder if having the rustdoc-types version numbers be equal to the lowest version of the rust-compiler they work on would be useful.

How would this work, given that rustdoc-json is only on nightly, so our versions look like 2024-01-18? Translating this into a semver version gets really ugly.

Maybe a table (maybe it already exists?) would be a better approach.

https://github.com/cargo-public-api/cargo-public-api?tab=readme-ov-file#compatibility-matrix is the closest to this I know of.

Actually a table in the readme or an <h1> link to a table in the readme for compatibility would be super useful!

I think the changelog would be the best place for this. Finding the data retroactively would be involved, but doable if someone wanted to. The release/changelog generator scripts would also need to be updated to do this automatically.

I’d be happy to add this, but probably won’t be working on it myself for a long time.

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

No branches or pull requests

2 participants