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

Tracking Issue for improved item code blocks #75303

Open
6 tasks
RDambrosio016 opened this issue Aug 8, 2020 · 1 comment
Open
6 tasks

Tracking Issue for improved item code blocks #75303

RDambrosio016 opened this issue Aug 8, 2020 · 1 comment
Labels
C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. S-tracking-unimplemented Status: The feature has not been implemented. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.

Comments

@RDambrosio016
Copy link
Contributor

RDambrosio016 commented Aug 8, 2020

This is a tracking issue for the improved item code blocks feature. Which is aimed at overall improving the quality of code blocks by removing explicit coloring and instead using the syntax highlighter. And also adding hyperlinks to each field (where applicable) which links to the specific section below the declaration. It was initially discussed in #75178 and it was decided it should be multiple PRs.

About tracking issues

Tracking issues are used to record the overall progress of implementation.
They are also uses as hubs connecting to other relevant issues, e.g., bugs or open design questions.
A tracking issue is however not meant for large scale discussion, questions, or bug reports about a feature.
Instead, open a dedicated issue for the specific matter and add the relevant feature gate label.

Steps

  • Remove explicit coloring in declaration code blocks and use the syntax highlighter.
  • Add hyperlinks for enum variants.
  • Add hyperlinks for pub struct fields.
  • Add hyperlinks for union fields.
  • Add hyperlinks for fields inside enum struct variants.

Unresolved Questions

  • Trait declarations seem to run the highlighter, but not completely, only for methods. Should we remove this and run the highlighter on the whole thing?

Implementation history

#75178 Initial closed pr with the discussion about this.

@RDambrosio016 RDambrosio016 added the C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. label Aug 8, 2020
@jyn514 jyn514 added the T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue. label Aug 8, 2020
@pnkfelix
Copy link
Member

Visiting for T-compiler backlog bonanza

@rustbot label: +S-tracking-unimplemented

@rustbot rustbot added the S-tracking-unimplemented Status: The feature has not been implemented. label Sep 23, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-tracking-issue Category: A tracking issue for an RFC or an unstable feature. S-tracking-unimplemented Status: The feature has not been implemented. T-rustdoc Relevant to the rustdoc team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants