Add inline_methods config option#139
Merged
Merged
Conversation
bschwedler
force-pushed
the
inline-methods-config
branch
from
cec94ac to
3888169
Compare
Control whether class methods get their own pages or stay inline on the class page via the inline_methods setting in great-docs.yml: inline_methods: true # always inline (never split) inline_methods: false # always split to separate pages inline_methods: 10 # inline up to 10, split above (default: 5) Replaces three hardcoded threshold = 5 checks with a single config-driven method on GreatDocsConfig.
bschwedler
force-pushed
the
inline-methods-config
branch
from
3888169 to
698e047
Compare
Member
|
Thanks @bschwedler for submitting this PR! I'm going to take it from here and add some more testing before final review and merging. |
Member
|
Merged, thanks @bschwedler ! |
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.
Summary
inline_methodssetting togreat-docs.ymlto control whether class methods get their own pages or stay inline on the class page> 5threshold checks incore.pywith a singleshould_split_methods()method onGreatDocsConfigUsage
The default behavior (split above 5 methods) is unchanged.
Details
null,"abc") fall back to the default threshold of 5