Skip to content

✨ Minimap - Markup comments #313

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

Open
BenjiMandel opened this issue Apr 24, 2025 · 0 comments
Open

✨ Minimap - Markup comments #313

BenjiMandel opened this issue Apr 24, 2025 · 0 comments
Labels
enhancement New feature or request

Comments

@BenjiMandel
Copy link

BenjiMandel commented Apr 24, 2025

Description

In many code editors(like xcode, vscode etc) the minimap provides the ability to also function as a table of contents.

That is done by using the following keywords:

//MARK: Regular Mark

//MARK: - Mark with line seperator

//TODO: A todo list item.

//TODO: - A todo list item with line seperator.

//FIXME: A fixme item

//FIXME: -  A fixme item with line seperator.

Image

This picture shows how it is implemented in xcode.

Additional Context

As can be seen in the picture above, the xcode minimap doesn't differentiate between TODO and FIXME. for both it does show a line separator.
I would suggest a few changes to xcode's implementation of todo and fixme.

  1. Both fixme and todo are not needed. just todo is good enough.
  2. It might be beneficial for todos to be shown in the minimap, not just as a line. Perhaps with a smaller font or just the word todo, showing there is a todo at that place.
  3. I don't think a line separator is needed for todo's
  4. It might be nice to have one of the left side panels to be a list of all todo's. If there aren't any in the code, perhaps it can be a built-in todo list (which is currently, I believe, way out of scope and for sure a feature on its own.)

Besides the line separator there is no difference between the 2 Mark's.
Perhaps it can be considered to make the mark without line separator regular font and slightly smaller, and to keep the line-separated mark bold and large.

Screenshots

No response

@BenjiMandel BenjiMandel added the enhancement New feature or request label Apr 24, 2025
@BenjiMandel BenjiMandel changed the title ✨ Minimap - Comments for a table of contents. ✨ Minimap - Markup comments Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
Status: 🆕 New
Development

No branches or pull requests

1 participant