Correctly render results_parser_callable parameter in Qubole operator docs
#25514
Conversation
This file contains 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
Within the Python API docs for both `QuboleCheckOperator` and `QuboleValueCheckOperator`, the `results_parser_callable` parameter is improperly listed under a "kwargs" section. This could be confusing to users reading the docs as this is an explicit input to these operators rather part of catch-all keyword args.
uranusjr
approved these changes
Aug 4, 2022
This was referenced Aug 10, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Within the Python API docs for both
QuboleCheckOperatorandQuboleValueCheckOperator, theresults_parser_callableparameter is improperly listed under a "kwargs" section. This could be confusing to users reading the docs as this is an explicit input to these operators rather part of catch-all keyword args.QuboleCheckOperatorBefore
After
QuboleValueCheckOperatorBefore
After
^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named
{pr_number}.significant.rstor{issue_number}.significant.rst, in newsfragments.