Fix params rendering in AzureSynapseHook Python API docs#29041
Merged
josh-fell merged 1 commit intoapache:mainfrom Jan 19, 2023
Merged
Fix params rendering in AzureSynapseHook Python API docs#29041josh-fell merged 1 commit intoapache:mainfrom
josh-fell merged 1 commit intoapache:mainfrom
Conversation
Trivial update to add a newline between the description and `:param:` directives in the AzureSynapseHook docstring. This allows the parameters to be rendered properly in the Python API documentation for better readability.
boring-cyborg
bot
added
area:providers
provider:microsoft-azure
ephraimbuddy
approved these changes
Jan 19, 2023
maggesssss
pushed a commit
to maggesssss/airflow
that referenced
this pull request
Jan 21, 2023
Trivial update to add a newline between the description and `:param:` directives in the AzureSynapseHook docstring. This allows the parameters to be rendered properly in the Python API documentation for better readability.
58 tasks
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.
Trivial update to add a newline between the description and
:param:directives in the AzureSynapseHook docstring. This allows the parameters to be rendered properly in the Python API documentation for better readability.Before
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.