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

Make pass through settings descriptions to adopt inline code #24182

Open
mjbvz opened this issue Sep 24, 2024 · 0 comments
Open

Make pass through settings descriptions to adopt inline code #24182

mjbvz opened this issue Sep 24, 2024 · 0 comments
Assignees
Labels
feature-request Request for new features or functionality triage-needed Needs assignment to the proper sub-team

Comments

@mjbvz
Copy link

mjbvz commented Sep 24, 2024

I noticed that a number of the Python setting descriptions could be improved by using markdown inline code instead of plain text. For example python.analysis.ignore

Image

The *, **, ?, and ${workspaceFolder...} parts would all be easier to read/understand if we used inline code for them instead of plain text

I noticed this problem in enough setting descriptions that I think it's worth doing a quick pass through all the Python settings during a debt week to make sure all of them are using Markdown when it would improve readability.

In general, inline code should be used for:

  • Actual code
  • Setting values, such as enum values for the setting
  • File paths/names
  • Character values, such as { when used in a setting like python.analysis.autoFormatStrings
  • Keyboard key names

Other things to adopt as part of this:

  • Split up long setting descriptions into a list / multiple lines when it would be useful. python.analysis.ignore could benefit from this

  • Make sure that any setting names in descriptions use the setting link syntax to create clickable links. For example `#python.analysis.typeCheckingMode#`. This setting name is currently rendered as plain text in python.analysis.diagnosticSeverityOverrides

@mjbvz mjbvz added the feature-request Request for new features or functionality label Sep 24, 2024
@github-actions github-actions bot added the triage-needed Needs assignment to the proper sub-team label Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature-request Request for new features or functionality triage-needed Needs assignment to the proper sub-team
Projects
None yet
Development

No branches or pull requests

2 participants