Make pass through settings descriptions to adopt inline code #24182
Labels
feature-request
Request for new features or functionality
triage-needed
Needs assignment to the proper sub-team
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
The
*
,**
,?
, and${workspaceFolder...}
parts would all be easier to read/understand if we used inline code for them instead of plain textI 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:
{
when used in a setting likepython.analysis.autoFormatStrings
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 thisMake 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 inpython.analysis.diagnosticSeverityOverrides
The text was updated successfully, but these errors were encountered: