@tus/s3-store: add missing docs for maxMultipartParts
#720
Conversation
🦋 Changeset detectedLatest commit: 280a6d4 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
This comment was marked as resolved.
This comment was marked as resolved.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/s3-store/README.md (1)
236-246: Improve sentence clarity in the Scaleway Object Storage example
The new example is very helpful for users configuring Scaleway Object Storage. However, the sentence on line 238 can be improved for grammatical clarity and flow. Consider rephrasing by adding a subject and a comma as suggested below to enhance readability.-`@tus/s3-store` can be used with Scaleway Object Storage but with some additional configuration. Scaleway Object Storage has a limit of 1000 parts in a multipart upload. +The `@tus/s3-store` package can be used with Scaleway Object Storage, but requires additional configuration. Specifically, Scaleway Object Storage imposes a limit of 1000 parts in a multipart upload.🧰 Tools
🪛 LanguageTool
[style] ~238-~238: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage@tus/s3-storecan be used with Scaleway Object Storage bu...(MISSING_IT_THERE)
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/s3-store/README.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/s3-store/README.md
[style] ~238-~238: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage @tus/s3-store can be used with Scaleway Object Storage bu...
(MISSING_IT_THERE)
[uncategorized] ~238-~238: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (1)
packages/s3-store/README.md (1)
77-84: Documentation clarity for part size limits
The updated text now explains that the server may increase the part size to not exceed theoptions.maxMultipartPartslimit, which improves configurability and clarity for users.
Co-authored-by: Merlijn Vos <[email protected]>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/s3-store/README.md (1)
237-244: New Scaleway Object Storage Example Added with Minor Language SuggestionThe example demonstrates the proper configuration for Scaleway Object Storage by setting
maxMultipartPartsto 1000, which aligns with the provider’s limitations. However, the descriptive sentence can be refined for improved clarity and grammatical completeness. For example:-`@tus/s3-store` can be used with Scaleway Object Storage but with some additional configuration. Scaleway Object Storage has a limit of 1000 parts in a multipart upload. +`@tus/s3-store` can be used with Scaleway Object Storage, but it requires additional configuration since Scaleway Object Storage has a limit of 1000 parts per multipart upload.This minor improvement will address the LanguageTool feedback on sentence structure and punctuation.
🧰 Tools
🪛 LanguageTool
[style] ~239-~239: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage@tus/s3-storecan be used with Scaleway Object Storage bu...(MISSING_IT_THERE)
[uncategorized] ~239-~239: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
packages/s3-store/README.md(3 hunks)
🧰 Additional context used
🪛 LanguageTool
packages/s3-store/README.md
[style] ~239-~239: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage @tus/s3-store can be used with Scaleway Object Storage bu...
(MISSING_IT_THERE)
[uncategorized] ~239-~239: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
packages/s3-store/README.md (3)
17-17: New Scaleway Example Link in TOC AddedThe new table of contents entry for the Scaleway Object Storage example is a welcome addition that helps users quickly locate the updated content. The anchor appears consistent with the header below.
78-79: Updated Reference inoptions.minPartSizeDescriptionThe text now dynamically refers to
options.maxMultipartPartsrather than a hardcoded S3 10K parts limit. This change improves clarity by linking the minimum part size behavior to the newly configurable maximum.
80-84: Newoptions.maxMultipartPartsDocumentation SectionThe added section clearly explains the new parameter. It specifies the default value and highlights the differences in limits among S3 providers. This addition enhances the documentation’s accuracy and usability.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
packages/s3-store/README.md (1)
237-247: Scaleway Object Storage Example – Language and Clarity Improvements
The Scaleway Object Storage example is a valuable addition. However, the explanatory text could be clarified for better readability. For example, instead of:
@tus/s3-storecan be used with Scaleway Object Storage but with some additional configuration. Scaleway Object Storage has a limit of 1,000 parts in a multipart upload.Consider rephrasing it to explicitly state the requirement. A suggested diff is provided below:
-`@tus/s3-store` can be used with Scaleway Object Storage but with some additional configuration. Scaleway Object Storage has a limit of 1,000 parts in a multipart upload. +`@tus/s3-store` can be used with Scaleway Object Storage; however, additional configuration is required because Scaleway Object Storage limits multipart uploads to 1,000 parts.This change addresses the static analysis hints regarding sentence structure and punctuation, making the instructions clearer and easier to follow.
🧰 Tools
🪛 LanguageTool
[style] ~239-~239: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage@tus/s3-storecan be used with Scaleway Object Storage bu...(MISSING_IT_THERE)
[uncategorized] ~239-~239: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
.changeset/thin-keys-whisper.md(1 hunks)packages/s3-store/README.md(3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
- .changeset/thin-keys-whisper.md
🧰 Additional context used
🪛 LanguageTool
packages/s3-store/README.md
[style] ~239-~239: To form a complete sentence, be sure to include a subject.
Context: ...caleway Object Storage @tus/s3-store can be used with Scaleway Object Storage bu...
(MISSING_IT_THERE)
[uncategorized] ~239-~239: Possible missing comma found.
Context: ...can be used with Scaleway Object Storage but with some additional configuration. Sca...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (3)
packages/s3-store/README.md (3)
17-17: Added Scaleway Example Entry in Contents
The new bullet point for "Example: use with Scaleway Object Storage" has been correctly added to the Contents section. This improves discoverability of the new example.
78-79: Update tooptions.minPartSizeDescription
The description now properly references the newoptions.maxMultipartPartslimit rather than the previously hardcoded "S3 10K parts limit." This update ensures that users understand the interplay betweenminPartSizeand the newly introducedmaxMultipartPartsoption.
80-85: Documentation of the Newoptions.maxMultipartPartsOption
The new section foroptions.maxMultipartPartsis clear and concise. It explains the default value and why a custom limit might be needed for some S3-compatible providers. This addition aligns well with the recent code changes and helps users adjust configurations based on provider limitations.
Murderlon
changed the title
maxMultipartParts
* main: @tus/azure-store: fix non-ASCII characters error on metadata (#725) Fix package-lock.json @tus/s3-store: add missing docs for `maxMultipartParts` (#720) [ci] release (#719) @tus/server: don't use AbortSignal.any to fix memory leak (#718) [ci] release (#713) Add .coderabbit.yml @tus/s3-store: add `maxMultipartParts` option (#712) [ci] release (#701) @tus/s3-store: add `minPartSize` option (#703)
* main: Refactor server to run in all (Node.js compatible) runtimes and meta frameworks (#710) [ci] release (#721) @tus/s3-store: fix unhandled promise rejection (#728) Bump @aws-sdk/client-s3 from 3.717.0 to 3.758.0 (#733) Bump @types/node from 22.10.1 to 22.13.7 (#734) Bump typescript from 5.6.2 to 5.8.2 (#731) @tus/azure-store: fix non-ASCII characters error on metadata (#725) Fix package-lock.json @tus/s3-store: add missing docs for `maxMultipartParts` (#720) [ci] release (#719) @tus/server: don't use AbortSignal.any to fix memory leak (#718) [ci] release (#713) Add .coderabbit.yml @tus/s3-store: add `maxMultipartParts` option (#712) [ci] release (#701) @tus/s3-store: add `minPartSize` option (#703)
2 participants
I didn't update documentation in #712.