rust-lang / rust-lang/rustdoc-types
Crazy idea: change rustdoc-types versions to match rust compiler
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 44
- Forks
- 20
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the README and the rustdoc-types versioning information referenced in the issue. The proposal presents two alternatives—matching rustc versions or documenting compatibility in a table—so the desired approach needs maintainer agreement before implementation; done would mean the chosen compatibility information is documented.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- documentation
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100