rust-lang / rust-lang/rfcs

Intern project: Annotated source browser

Open
#611 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

T-dev-tools
Dominant language
Markdown
Stars
6.6k
Forks
1.7k
Avg merge
16h 14m
Merged PRs (30d)
1

Description

Issue by nikomatsakis
Thursday Sep 13, 2012 at 17:40 GMT

For earlier discussion, see https://github.com/rust-lang/rust/issues/3485

This issue was labelled with: A-an-interesting-project, A-tools, I-wishlist in the Rust repository


I was thinking: it'd be very cool to have a tool based on rustc that presented an annotated view of the source code, showing:

  • the inferred types of local variables, expressions;
  • hyperlinks between fn calls and the source text;
  • monomorphized versions of generic fns etc specific to a particular call site

This might also be useful in presenting error messages and so forth.

Seems like it would make a great intern project (we should have a tag for that).

Contributor guide

No contributing guide indexed for this repository

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 with the earlier discussion referenced in rust-lang/rust#3485, then review the proposed rustc-based annotated source browser here. Establish the scope before implementation: inferred types, call hyperlinks, and monomorphized generic functions are all listed as goals; done would require a working tool that presents the agreed subset.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.