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

"Side Bar: Count Badge" preference not specified #739

Open
Chealer opened this issue Aug 9, 2024 · 4 comments
Open

"Side Bar: Count Badge" preference not specified #739

Chealer opened this issue Aug 9, 2024 · 4 comments

Comments

@Chealer
Copy link

Chealer commented Aug 9, 2024

The Bookmark extension's Side Bar: Count Badge preference has the following description:

Controls the count badge on the Bookmark icon on the Activity Bar

It can have 3 values:

  • all
  • files
  • off

Unfortunately, the labels all not clear and the description does not specify what they mean.


  • Extension version: 13.5.0
@Chealer Chealer added the bug label Aug 9, 2024
@alefragnani
Copy link
Owner

H @Chealer ,

This setting is documented in the README file, presented in the Marketplace page:


  • Controls the count badge on the Bookmark icon on the Activity Bar (all by default)

    • all: Show the sum of bookmarks from all files
    • files: Show the sum of files that contains some bookmarks
    • off: Disable the Bookmarks count badge
    "bookmarks.sideBar.countBadge": "files"

And the same description is provided within the VS Code Settings Editor, both UI and JSON, as you can see in the print below:

image

Do you mean you didn't find its descriptions, or you didn't understand what each one of them mean?

Hope this helps

@Chealer
Copy link
Author

Chealer commented Aug 12, 2024

Thank you very much @alefragnani
To clarify, here is the section @alefragnani refers to.

@Chealer
Copy link
Author

Chealer commented Aug 12, 2024

Do you mean you didn't find its descriptions, or you didn't understand what each one of them mean?

I hadn't found the descriptions. I am sorry I hadn't read the README, but I admit that I didn't expect that this information would be in the README but not in the user interface. I recommend to have that information in the description (above) or to clarify the labels. I suggest to simply replace the current labels with the "label explanations" in the README. However, these explanations are themselves not so clear. For instance, does "Show the sum of files that contains some bookmarks" mean to show the number of files which contain at least one bookmark?

By the way, I believe the README's Features section is excessively long. For reference, even the features section of a large product's documentation like MySQL's fits in 3 pages.

@alefragnani
Copy link
Owner

Well, the labels could indeed be more verbose, similar to the bookmarks.multicursor.toggleMode setting, but I think their descriptions provides a reasonable message. Specifically about the contains some bookmarks, yes, it means contains at least one bookmark. I'll update the description as you suggested.

About updating the labels, this is not straightforward, since users may have already selected some actual label, and replacing it with a new value won't automatically migrate. For this reason, the labels will remain the same.

Hope this helps

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

No branches or pull requests

2 participants