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

replace ~ with . for marking up sections #33369

Merged
merged 2 commits into from
Aug 13, 2023
Merged

Conversation

qleroy
Copy link
Contributor

@qleroy qleroy commented Aug 13, 2023


This PR restores the preview feature for ./BREEZE.rst.
I described the issue here #33368 .
The change replaces the tilde ~ character for marking section with -.

@boring-cyborg
Copy link

boring-cyborg bot commented Aug 13, 2023

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@potiuk
Copy link
Member

potiuk commented Aug 13, 2023

Right. but better fix will be to replace it with `........................" (dots.) - the problem is that the TOC level is now inconsistent with some previous TOC levels (SBOM) (and ..... will bring the consistency back).

@qleroy qleroy changed the title replace ~ with - for marking up sections replace ~ with . for marking up sections Aug 13, 2023
@potiuk potiuk merged commit 4263854 into apache:main Aug 13, 2023
@boring-cyborg
Copy link

boring-cyborg bot commented Aug 13, 2023

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

ferruzzi pushed a commit to aws-mwaa/upstream-to-airflow that referenced this pull request Aug 17, 2023
* replace ~ with - for marking up sections

* fix TOC level with '.'
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants