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

docs: Javadocs for TransferManager interface and ParallelUploadConfig #2094

Merged
merged 8 commits into from Jun 26, 2023

Conversation

sydney-munro
Copy link
Collaborator

First commit for Javadocs. Will continue to add files as I write them but wanted to get initial feedback to ensure this is the direction we would like the javadocs to go and they are clear.

@sydney-munro sydney-munro requested a review from a team as a code owner June 23, 2023 18:43
@product-auto-label product-auto-label bot added size: m Pull request size is medium. api: storage Issues related to the googleapis/java-storage API. labels Jun 23, 2023
Copy link
Member

@frankyn frankyn left a comment

Choose a reason for hiding this comment

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

LGTM, just had one q which is from me not remember javadoc;

Copy link
Collaborator

@BenWhitehead BenWhitehead left a comment

Choose a reason for hiding this comment

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

  1. I'd like to see the @see cross links on the builder setters/config getters.
  2. Adding a note to uploadFiles/downloadBlobs to note they do not block the invoking thread waiting for all the work to complete.
  3. A few nits/alternative pharasings - if you feel these don't clarify anything feel free to ignore.

sydney-munro and others added 4 commits June 23, 2023 14:22
…ansfermanager/ParallelDownloadConfig.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
…ansfermanager/ParallelUploadConfig.java

Co-authored-by: BenWhitehead <BenWhitehead@users.noreply.github.com>
@sydney-munro sydney-munro merged commit 63d8ed3 into feat/transfer-manager Jun 26, 2023
19 checks passed
@sydney-munro sydney-munro deleted the javadocs branch June 26, 2023 18:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api: storage Issues related to the googleapis/java-storage API. size: m Pull request size is medium.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants