Skip to content

Remove misplaced backquotes in faq.rst#39661

Merged
kaxil merged 1 commit intoapache:mainfrom
le-chartreux:patch-1
May 16, 2024
Merged

Remove misplaced backquotes in faq.rst#39661
kaxil merged 1 commit intoapache:mainfrom
le-chartreux:patch-1

Conversation

@le-chartreux
Copy link
Copy Markdown
Contributor

closes: #39660

In the section 'What’s the deal with start_date?' of the FAQ, two back quotes (``) are in the middle of an inline code (line 224 of faq.rst):

``start_date=``datetime(2024, 1, 1)``

This leads to a bad rendering where the two back quotes appears between = and datetime(2024, 1, 1), like this: start_date=``datetime(2024, 1, 1) (or picture just bellow).

Bad rendering of inline code

I removed the two back quotes in the middle of the inline code, so now it renders without them.

In the section 'What’s the deal with start_date?' of the FAQ, two back quotes are in the middle of an inline code (line 224): ``start_date=``datetime(2024, 1, 1)``.
This leads to a bad rendering where the two back quotes appears between the = and datetime(2024, 1, 1), like this: start_date=``datetime(2024, 1, 1)
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented May 16, 2024

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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.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

@Taragolis
Copy link
Copy Markdown
Contributor

Nice! Feel free to create a PR without an Issue in the future if you want to fix something

@eladkal eladkal added this to the Airflow 2.9.2 milestone May 16, 2024
@eladkal eladkal added the type:doc-only Changelog: Doc Only label May 16, 2024
@le-chartreux
Copy link
Copy Markdown
Contributor Author

Hi @Taragolis,
OK, thank you for this information, I was thinking I needed to link an issue to my PR.
In the future, I will only create a PR then :)

@le-chartreux
Copy link
Copy Markdown
Contributor Author

Hi, is it normal that the CI failed on "Lint Docker compose files with JSON Schema" even if I didn't modified any Docker compose file?
The only change I made to the codebase was removing two back quotes in the documentation, so I don't understand why it fails on something like this.

@Taragolis
Copy link
Copy Markdown
Contributor

Hi, is it normal that the CI failed on "Lint Docker compose files with JSON Schema" even if I didn't modified any Docker compose file?

Yeah, that is kind of different issue which is not relevant to your changes, should be temporary fixed by #39662

@kaxil kaxil added the changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) label May 16, 2024
@kaxil kaxil merged commit 435ba14 into apache:main May 16, 2024
@boring-cyborg
Copy link
Copy Markdown

boring-cyborg bot commented May 16, 2024

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

@kaxil
Copy link
Copy Markdown
Member

kaxil commented May 16, 2024

Congrats on your first PR @le-chartreux 👏

@le-chartreux
Copy link
Copy Markdown
Contributor Author

Thank you @kaxil!
And thank you everyone for all your work on Airflow, it's such a great tool 👏

@le-chartreux le-chartreux deleted the patch-1 branch May 16, 2024 11:01
ephraimbuddy pushed a commit that referenced this pull request Jun 4, 2024
In the section 'What’s the deal with start_date?' of the FAQ, two back quotes are in the middle of an inline code (line 224): ``start_date=``datetime(2024, 1, 1)``.
This leads to a bad rendering where the two back quotes appears between the = and datetime(2024, 1, 1), like this: start_date=``datetime(2024, 1, 1)

(cherry picked from commit 435ba14)
ephraimbuddy pushed a commit that referenced this pull request Jun 5, 2024
In the section 'What’s the deal with start_date?' of the FAQ, two back quotes are in the middle of an inline code (line 224): ``start_date=``datetime(2024, 1, 1)``.
This leads to a bad rendering where the two back quotes appears between the = and datetime(2024, 1, 1), like this: start_date=``datetime(2024, 1, 1)

(cherry picked from commit 435ba14)
romsharon98 pushed a commit to romsharon98/airflow that referenced this pull request Jul 26, 2024
In the section 'What’s the deal with start_date?' of the FAQ, two back quotes are in the middle of an inline code (line 224): ``start_date=``datetime(2024, 1, 1)``.
This leads to a bad rendering where the two back quotes appears between the = and datetime(2024, 1, 1), like this: start_date=``datetime(2024, 1, 1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog:skip Changes that should be skipped from the changelog (CI, tests, etc..) kind:documentation type:doc-only Changelog: Doc Only

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Bad rendering of an inline code in the documentation

5 participants