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

Explain the difference between higlighting and listAnnotations better #28

Open
alkatar21 opened this issue Sep 3, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@alkatar21
Copy link
Collaborator

For me it was not immediately clear from the README that higlighting and listAnnotations do not work the same way and so I had expected at first that everything that is higlighted also appears in the list.
While the former works in all files, even in the settings, listAnnotations respects todohighlight.include and todohighlight.exclude and is more or less an own independent function.

I would suggest the following options:

  • In the README, emphasize more strongly that these are 2 more or less different features. Maybe also mark the options accordingly.
  • higlighting also respects these settings.
    Thus the extension could start in a further step only if a corresponding file type is called and improves thereby also the VSCode startup time.
@jlopes26
Copy link

jlopes26 commented Sep 7, 2021

yap, I was just right to open a issue when I saw this and then understand the reason why the listAnnotations "didn't work"
Just added the extension .cs to the included and it worked right away

//thanks Jonathan Clark for the fork and all the hard work

@jgclark jgclark self-assigned this Jan 14, 2022
@jgclark jgclark added the documentation Improvements or additions to documentation label Jan 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants