Docstring improvements #31375
Merged
Docstring improvements #31375
Conversation
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
The param documentation is changed to use Sphinx-style.
Docstring is re-formatted. Also slightly tweaked the annotation and log format but nothing functionally.
I don't think many people would actually need this docstring (DagRun being so fundamental to Airflow at this point), but the new text should be more useful in terms of describing how Airflow model things these days.
The previous docstring mentions a trigger can have a relationship to DAG, which doesn't seem to match reality, so I changed it.
Those seems to simply miss an empty line between the actual summary and detailed description. Code block formatting in BranchDayOfWeekOperator also needed some fixes.
Those are a mess!
Also use some typing to replace text form type descriptions.
They are useless. Also reformatted quite some docstrings en passe.
uranusjr
requested review from
ashb,
bbovenzi,
bolkedebruin,
dstandish,
ephraimbuddy,
jedcunningham,
kaxil,
potiuk and
ryanahamilton
as code owners
boring-cyborg
bot
added
area:API
eladkal
approved these changes
May 18, 2023
Member
|
Conflicts to resolve now :) |
vincbeck
approved these changes
May 18, 2023
potiuk
approved these changes
May 18, 2023
eladkal
added
the
type:misc/internal
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 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.
Some manual docstring improvements I gathered when reviewing #31297, submitted separately to not expand the PR scope.