Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Several improvements to the Params doc #29062

Merged
merged 3 commits into from Jan 21, 2023
Merged

Conversation

BasPH
Copy link
Contributor

@BasPH BasPH commented Jan 20, 2023

The PR makes several improvements to https://airflow.apache.org/docs/apache-airflow/stable/concepts/params.html:

  • Moved task-level params paragraph up to create a more logical structure
  • Emphasized several code examples
  • Fixed a hyperlink
  • Spelling fixes
  • Simplified first paragraph for clarity
  • Auto-register DAGs in code examples

^ 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.rst or {issue_number}.significant.rst, in newsfragments.

@jedcunningham jedcunningham added the type:doc-only Changelog: Doc Only label Jan 20, 2023
@jedcunningham jedcunningham added this to the Airflow 2.5.2 milestone Jan 20, 2023
Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
Copy link
Member

@potiuk potiuk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice little improvements :)

@BasPH BasPH merged commit af9143e into apache:main Jan 21, 2023
@BasPH BasPH deleted the params-doc-fixes branch January 21, 2023 13:14
pierrejeambrun pushed a commit that referenced this pull request Mar 7, 2023
* Several improvements to the Params doc

* Rewrite first paragraph for clarity

* Update docs/apache-airflow/core-concepts/params.rst

Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>

Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
(cherry picked from commit af9143e)
pierrejeambrun pushed a commit that referenced this pull request Mar 8, 2023
* Several improvements to the Params doc

* Rewrite first paragraph for clarity

* Update docs/apache-airflow/core-concepts/params.rst

Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>

Co-authored-by: Jed Cunningham <66968678+jedcunningham@users.noreply.github.com>
(cherry picked from commit af9143e)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants