Rearrange client crate and improve its docs #511
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Error
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Error
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Error
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Error
jamesbornholt
force-pushed
the
client-docs
branch
from
2bb1f65 to
770658e
Compare
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
force-pushed
the
client-docs
branch
from
770658e to
f51716e
Compare
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
passaro
reviewed
Sep 12, 2023
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
jamesbornholt
had a problem deploying
to
PR integration tests
GitHub Actions
Failure
Yep, will do a crate release in a separate PR so I can get the changelogs up to date. |
The current docs page for the client crate is pretty indecipherable. While we're not currently suggesting customers use it directly, we know a few already are, and we'd like the docs to be legible. So this commit moves around a bunch of the public structure of the client crate to be consistent and intentional. There's no semantics changes here, this is all just rearranging and commenting stuff that wasn't commented before. Signed-off-by: James Bornholt <[email protected]>
Signed-off-by: James Bornholt <[email protected]>
jamesbornholt
force-pushed
the
client-docs
branch
from
7f1a9a3 to
e9ce0ad
Compare
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
jamesbornholt
temporarily deployed
to
PR integration tests
GitHub Actions
Inactive
passaro
approved these changes
Sep 15, 2023
jamesbornholt
added a commit
to jamesbornholt/mountpoint-s3
that referenced
this pull request
Sep 26, 2023
It's been 3 months, and I want to get awslabs#511 out, so this change bundles up all the changes to all 3 crates. The changes to the two CRT crates probably aren't strictly breaking changes, but I haven't inspected the CRT changelogs closely enough to be sure. Signed-off-by: James Bornholt <[email protected]>
github-merge-queue bot
pushed a commit
that referenced
this pull request
Sep 26, 2023
It's been 3 months, and I want to get #511 out, so this change bundles up all the changes to all 3 crates. The changes to the two CRT crates probably aren't strictly breaking changes, but I haven't inspected the CRT changelogs closely enough to be sure. Signed-off-by: James Bornholt <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of change
The current docs page for the client crate is pretty indecipherable. While we're not currently suggesting customers use it directly, we know a few already are, and we'd like the docs to be legible. So this commit moves around a bunch of the public structure of the client crate to be consistent and intentional.
There's no semantics changes here, this is all just rearranging and commenting stuff that wasn't commented before.
Does this change impact existing behavior?
This is a breaking change to the mountpoint-s3-client crate because it changes the module structure, but it has no semantics changes.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license and I agree to the terms of the Developer Certificate of Origin (DCO).