KEMBAR78
docs: Javadocs for TransferManager interface and ParallelUploadConfig by sydney-munro · Pull Request #2094 · googleapis/java-storage · GitHub
Skip to content

Conversation

@sydney-munro
Copy link
Contributor

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
Contributor

@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
@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.

3 participants