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

Request for get_config_docstrings to also decorate default configuration settings #252

Open
mcfadden8 opened this issue Mar 11, 2020 · 1 comment

Comments

@mcfadden8
Copy link

For messages with true or false values, it would be nice if get_config_docstrings could add decorations to signify current setting versus default settings where possible.

For example, something like this would be handy:

profile.cuda=true(D)|false: Profile CUDA API functions (e.g., cudaMalloc)

(D) - Default setting

@daboehme
Copy link
Member

Ok, I'll add default values in the docstrings where I can. It's not entirely trivial in all cases because the value may be determined at runtime or it can be different in different controllers, so it may take some effort to get this in. For what its worth, virtually all boolean options are off by default.

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

2 participants