-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
[yaml] Enhance YAML API docs #32825
[yaml] Enhance YAML API docs #32825
Conversation
R: @robertwb |
019e71c
to
5bcc47b
Compare
Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment |
5bcc47b
to
f65a828
Compare
f65a828
to
a8987bd
Compare
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #32825 +/- ##
============================================
+ Coverage 60.39% 60.44% +0.04%
Complexity 15099 15099
============================================
Files 2735 2736 +1
Lines 265201 265331 +130
Branches 12106 12106
============================================
+ Hits 160171 160378 +207
+ Misses 98610 98533 -77
Partials 6420 6420
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
a8987bd
to
ab7ba19
Compare
Signed-off-by: Jeffrey Kinard <[email protected]>
Signed-off-by: Jeffrey Kinard <[email protected]>
Signed-off-by: Jeffrey Kinard <[email protected]>
Signed-off-by: Jeffrey Kinard <[email protected]>
ab7ba19
to
bc08051
Compare
named_field: element | ||
literal_int: 10 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We should try to get to the bottom of this... File a bug?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Agreed, this isn't super sustainable. I think we can just use #32832
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This looks lots nicer.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks!
Test failures are pretty clearly unrelated, so I'm going to merge |
The current YAML API refernce docs look like the following:
This PR adds formatting to make the docs look more like the Sphinx-themed PyDocs used by the Python SDK:
This change
not onlyadds some color and easier-to-read formatting, but also separates the transforms into individual pages to reduce clutter. This should hopefully make the user-experience a bit better.UPDATE: the doc will remain as one page, but will include the new side panel and formatting changes.
Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:
addresses #123
), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, commentfixes #<ISSUE NUMBER>
instead.CHANGES.md
with noteworthy changes.See the Contributor Guide for more tips on how to make review process smoother.
To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md
GitHub Actions Tests Status (on master branch)
See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.