Doc updates to nimble options#286
Merged
Merged
Conversation
whatyouhide
approved these changes
Feb 16, 2022
Collaborator
whatyouhide
left a comment
whatyouhide
left a comment
There was a problem hiding this comment.
Ah nice, good catch! ❤️
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
There are several places in the docs where the defaults are rendered twice because the defaults are hardcoded into the
docstring and rendered by nimble_options.min_demandis different because no default is set in the nimble_options definition. In this case, I believe the docs were inaccurate when they said, "Default value is5." If I'm understanding correctly, this line ingen_stageis where the default formin_demandis set to half ofmax_demand. This value will not necessarily be5.