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

[yaml] Enhance YAML API docs #32825

Merged
merged 4 commits into from
Oct 31, 2024
Merged

[yaml] Enhance YAML API docs #32825

merged 4 commits into from
Oct 31, 2024

Conversation

Polber
Copy link
Contributor

@Polber Polber commented Oct 16, 2024

The current YAML API refernce docs look like the following:
image

This PR adds formatting to make the docs look more like the Sphinx-themed PyDocs used by the Python SDK:
image

This change not only adds 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:

  • Mention the appropriate issue in your description (for example: 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, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

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)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI or the workflows README to see a list of phrases to trigger workflows.

@Polber
Copy link
Contributor Author

Polber commented Oct 16, 2024

R: @robertwb

Copy link
Contributor

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control. If you'd like to restart, comment assign set of reviewers

Copy link

codecov bot commented Oct 25, 2024

Codecov Report

Attention: Patch coverage is 0% with 4 lines in your changes missing coverage. Please review.

Project coverage is 60.44%. Comparing base (67dc973) to head (a8987bd).
Report is 7 commits behind head on master.

Files with missing lines Patch % Lines
sdks/python/apache_beam/yaml/generate_yaml_docs.py 0.00% 4 Missing ⚠️
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              
Flag Coverage Δ
python 81.59% <0.00%> (+0.14%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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]>
@liferoad
Copy link
Collaborator

named_field: element
literal_int: 10
Copy link
Contributor

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?

Copy link
Contributor

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

Copy link
Contributor

@robertwb robertwb left a 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.

Copy link
Contributor

@damccorm damccorm left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@damccorm
Copy link
Contributor

Test failures are pretty clearly unrelated, so I'm going to merge

@damccorm damccorm merged commit afaa4c3 into apache:master Oct 31, 2024
91 checks passed
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.

5 participants