docs: add class docstrings to concrete ParamType implementations#3296
Closed
mastash3ff wants to merge 1 commit intopallets:mainfrom
Closed
docs: add class docstrings to concrete ParamType implementations#3296mastash3ff wants to merge 1 commit intopallets:mainfrom
mastash3ff wants to merge 1 commit intopallets:mainfrom
Conversation
StringParamType, IntParamType, FloatParamType, BoolParamType, and UUIDParameterType are the backing implementations for the click.STRING, INT, FLOAT, BOOL, and UUID constants respectively. All other ParamType subclasses with distinct behaviour (Choice, IntRange, FloatRange, File, Path, Tuple) already have class docstrings; add the missing ones here.
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
The concrete
ParamTypesubclasses that back theclick.STRING,click.INT,click.FLOAT,click.BOOL, andclick.UUIDconstants are missing class-leveldocstrings. All other
ParamTypesubclasses with distinct behaviour(
Choice,IntRange,FloatRange,File,Path,Tuple) already haveclass docstrings; this PR fills the gap for the five basic types.
Changes
StringParamType: describes the type, its constant, and bytes decoding behaviourIntParamType: describes the type, its constant, and includes a usage exampleFloatParamType: describes the type, its constant, and includes a usage exampleBoolParamType: describes the truthy/falsy string values accepted and notesthat Click uses this type automatically for
is_flag=TrueoptionsUUIDParameterType: describes the type, its constant, and accepted string formats