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

Bad rendering of an inline code in the documentation #39396

Closed
1 of 2 tasks
le-chartreux opened this issue May 3, 2024 · 2 comments · Fixed by #39401
Closed
1 of 2 tasks

Bad rendering of an inline code in the documentation #39396

le-chartreux opened this issue May 3, 2024 · 2 comments · Fixed by #39401
Labels
kind:bug This is a clearly a bug kind:documentation

Comments

@le-chartreux
Copy link
Contributor

le-chartreux commented May 3, 2024

What do you see as an issue?

Hello Airflow Team,

On the "Using UI" part of the "DAG Runs" documentation, the rendering of the following line is broken on my web browser:

If the DAG does not define params the form is usually skipped, via the configuration option show_trigger_form_if_no_params it is possible to force the display the classic form of a dict-only entry to pass configuration options.

It renders like this on my computer with Chrome (124.0.6367.118) and Edge (124.0.2478.67), and I have the same problem on Android with Firefox (125.2.0):

bad rendering of airflow documentation

I believe "params" and "show_trigger_form_if_no_params" is supposed to be rendered as inline code, but "the form is usually skipped, via the configuration option" shouldn't.

Your software is awesome, thanks for your work!
Best regards,

Nathan

Solving the problem

It's maybe just an issue with the .rst file (e.g. missing space), but I'm not familiar with the rst format.

Anything else

No response

Are you willing to submit PR?

  • Yes I am willing to submit a PR!

Code of Conduct

@le-chartreux le-chartreux added kind:bug This is a clearly a bug kind:documentation needs-triage label for new issues that we didn't triage yet labels May 3, 2024
Copy link

boring-cyborg bot commented May 3, 2024

Thanks for opening your first issue here! Be sure to follow the issue template! If you are willing to raise PR to address this issue please do so, no need to wait for approval.

@Taragolis
Copy link
Contributor

Taragolis commented May 4, 2024

Missing whitespace after the ``params``

If the DAG does not define ``params``the form is usually skipped, via the configuration option ``show_trigger_form_if_no_params``

image

image

@Taragolis Taragolis removed the needs-triage label for new issues that we didn't triage yet label May 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:bug This is a clearly a bug kind:documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants