Skip to content

Fix formatting of config values in documentation #244

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

Open
Denton-L opened this issue May 31, 2019 · 0 comments
Open

Fix formatting of config values in documentation #244

Denton-L opened this issue May 31, 2019 · 0 comments

Comments

@Denton-L
Copy link
Member

Currently, in our config documentation, there are many inconsistencies with the way values are being marked up. This patch is a very small start but we should try to go through all of the config/*.txt files and mark up config values with surrounding backticks. This way, it'll be obvious that these are special values that a user should pay attention to.

In particular, true and false are major offenders for not being surrounded by backticks.

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

No branches or pull requests

1 participant