Skip to content

Document default values #2302

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
byzyk opened this issue Jun 27, 2018 · 0 comments
Open

Document default values #2302

byzyk opened this issue Jun 27, 2018 · 0 comments
Assignees

Comments

@byzyk
Copy link
Member

byzyk commented Jun 27, 2018

Problem

Default config values are sometimes mentioned in property description (this is not very readable and clear) or not mentioned at all. Users need to dive into the source code to see what default value really is, which is not very handy.

Solution

Mention default values where possible, perhaps alongside the types:

screenshot at jun 27 10-24-03

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