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

refs: issue-27728, Improve java sdk docs #27724

Merged
merged 4 commits into from
Jul 28, 2023
Merged

Conversation

Laksh47
Copy link
Contributor

@Laksh47 Laksh47 commented Jul 27, 2023

Fixes #27728

Description:

  • Keep documentation consistent across SDKs
  • Java SDK docs doesn't mention detail about inequality queries for withNumQuerySplits function
  • Python SDK docs mention the same here

javadoc:
Screenshot 2023-07-27 at 7 55 49 PM

pydoc:
Screenshot 2023-07-27 at 7 56 40 PM

context: faced this exception while running a dataflow job that utilizes this function
Screen Shot 2023-07-27 at 8 00 30 PM


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.

@github-actions
Copy link
Contributor

Assigning reviewers. If you would like to opt out of this review, comment assign to next reviewer:

R: @Abacn for label java.
R: @bvolpato for label io.

Available commands:

  • stop reviewer notifications - opt out of the automated review tooling
  • remind me after tests pass - tag the comment author after tests pass
  • waiting on author - shift the attention set back to the author (any comment or push by the author will return the attention set to the reviewers)

The PR bot will only process comments in the main thread (not review comments).

@Laksh47 Laksh47 changed the title Improve sdk docs refs: issue-27728, Improve java sdk docs Jul 28, 2023
Copy link
Contributor

@bvolpato bvolpato left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you Laksh!

@Abacn
Copy link
Contributor

Abacn commented Jul 28, 2023

Thank you!

@Abacn Abacn merged commit d966b6b into apache:master Jul 28, 2023
12 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.

Update datastore function docs for java sdk
3 participants