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

README: Available Settings section unclear #744

Open
Chealer opened this issue Aug 13, 2024 · 0 comments
Open

README: Available Settings section unclear #744

Chealer opened this issue Aug 13, 2024 · 0 comments

Comments

@Chealer
Copy link

Chealer commented Aug 13, 2024

The README's Available Settings section documents about 20 settings, but its format is hard to read. There is a JSON excerpt associated with each setting, and some notes.

For example, for the first setting, the content is:
image

This is confusing because:

  1. Excerpts are not described.
  2. Notes and excerpts are outside of their corresponding entry.
  3. Some descriptions are unclear (for example, the first one).
  4. The described settings are not indicated.
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