rust-lang / rust-lang/rust

rustdoc-json: Change `Self` type representation

Open
#128,522 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

A-rustdoc-json C-enhancement T-rustdoc
Dominant language
Rust
Stars
119k
Forks
16.1k
PR merge metrics
PR metrics pending

Description

This is fine for now as it preserves the existing behavior, but yeah this should almost certainly be changed in a future PR

Originally posted by @aDotInTheVoid in https://github.com/rust-lang/rust/pull/128471#discussion_r1700993187

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reading the rustdoc-json implementation and the discussion quoted from PR 128471. Determine the intended representation for Self types and the affected JSON behavior before identifying the necessary validation. Done means the rustdoc JSON output uses the agreed representation consistently.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
compilers, documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.