rustdoc-json-types: Rename and document Impl::synthetic
Nobody has claimed this yet.
- Dominant language
- Rust
- Stars
- 119k
- Forks
- 16.1k
- PR merge metrics
- PR metrics pending
Description
"synthetic" impls arn't a really a term that are used, especially in user-facing documentation. It's quite confusing to users that we use this to refer to impl's of auto trait. It's lead to users beliving (and understandably so) that the JSON output doesn't contain wether an impl is auto or not. (eg, CC @zjp-CN).
We should rename this field to something more descriptive. An ititial proposal would be is_auto, but I'm not sure this is quite right, as it's the trait that's auto, not the impl. I'm open to suggestions for the field name.
While we're at it, we should document it and add tests.
Contributor guide
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 at rustdoc-json-types::Impl::synthetic and inspect the existing rustdoc JSON tests and documentation around the field. Resolve the field name and semantics, then rename it, document whether it identifies auto traits, and add tests covering the JSON output.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- rust
- Domain
- compilers, documentation
- Issue type
- Refactor
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100