Skip to content

Halfway down a long method or class, I can't see what I'm inside of #349

Description

@a-team-app

Opportunity

Halfway down a long method or class, I can't see what I'm inside of.

The vision's user spends most of the day reading code they didn't write, often in a narrow terminal over SSH. Once a method's signature scrolls off the top, there's nothing on screen that says which method, or which class, the lines in front of you belong to. You scroll back up to find out and lose your place, or open Go to symbol (gs) just to read where you are. It gets worse in exactly the files you're trying to understand: long classes, nested types, and big Markdown docs where the heading you're under scrolled away pages ago. Jumping in from Find results, blame or a diff lands you mid-file with no context at all.

Evidence

Why it fits

  • Vision, Who it's for: "spend most of their time navigating code bases, reviewing PRs and trying to understand existing/new code". Knowing where you are is the first step in understanding code.
  • Familiar: VS Code and JetBrains users both have this on by default now, and they'll notice it's missing.
  • Terminal-honest: a narrow terminal shows fewer lines, so the signature scrolls away sooner, which makes the need bigger in a terminal than in a GUI. Sticky rows cost screen height, though, and a status-bar or tab-title readout would cost none. That trade-off is for the pitch.
  • Nothing is added to the binary. It reuses the symbol scan that's already there.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    a-team:ideaFound by the a-team Lead; give it a Priority to have it pitched

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions