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

FIx formatting of Dataset inlet/outlet note in TaskFlow concepts #29678

Merged
merged 1 commit into from
Feb 21, 2023

Conversation

josh-fell
Copy link
Contributor

Before
image

After
image

@eladkal eladkal added this to the Airflow 2.5.2 milestone Feb 21, 2023
@eladkal eladkal added the type:doc-only Changelog: Doc Only label Feb 21, 2023
@Taragolis Taragolis merged commit 9de301d into main Feb 21, 2023
@vemikhaylov
Copy link
Contributor

@josh-fell josh-fell deleted the josh-fell-patch-1 branch February 21, 2023 21:55
@josh-fell
Copy link
Contributor Author

Can it make sense to replace all (or almost all) such "Note: " places in ".rst" with the corresponding formatting?

For instance,

https://airflow.apache.org/docs/apache-airflow-providers-google/stable/operators/cloud/video_intelligence.html

https://github.com/apache/airflow/blob/main/docs/apache-airflow-providers-google/operators/cloud/video_intelligence.rst#more-information

Screenshot 2023-02-21 at 21 38 26

@vemikhaylov Maybe? This was fixing readability and it looked like the rST had a directive started but never finished (i.e. just a hanging ..); however, if you feel there are improvements to be made to the docs, PRs are absolutely welcome! If that includes converting these explicit notes to a formatted one, I'd say go for it.

@vemikhaylov
Copy link
Contributor

vemikhaylov commented Feb 22, 2023

it looked like the rST had a directive started but never finished (i.e. just a hanging ..);

I'm definitely not an RST expert, but I think just a single :: quotes the paragraph below exactly as it was seen on your screenshot in the PR description. On wiki they call it "blockquoting" (https://en.wikipedia.org/wiki/ReStructuredText). You can search in the repo (^::\n), it's used in several places, somewhere probably it's justified.

however, if you feel there are improvements to be made to the docs, PRs are absolutely welcome! If that includes converting these explicit notes to a formatted one, I'd say go for it.

Sure thing, I'll create a PR to move to the explicit RST note usage where it makes sense. Thanks!

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.

4 participants