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.

Sign up for GitHub

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

Jump to bottom

Tuning S3_File doc comments. #10832

Merged
merged 3 commits into from
Aug 16, 2024
Merged

Tuning S3_File doc comments. #10832

merged 3 commits into from
Aug 16, 2024

Conversation

jdunkerley
Copy link
Member

@jdunkerley jdunkerley commented Aug 16, 2024 •
edited
Loading

Pull Request Description

  • Review and update the doc comments of public functions in the AWS library.
  • Reorder the functions to make the order in component browser (and online docs better).
  • Align some error handling.
  • Fix bug with list on root S3.
  • Hide S3.get_object as it's single read makes it bad for GUI use.

Checklist

Please ensure that the following checklist has been satisfied before submitting the PR:

  • The documentation has been updated, if necessary.
  • Screenshots/screencasts have been attached, if there are any visual changes. For interactive or animated visual changes, a screencast is preferred.
  • All code follows the
    Scala,
    Java,
    TypeScript,
    and
    Rust
    style guides. In case you are using a language not listed above, follow the Rust style guide.
  • Unit tests have been written where possible.

@jdunkerley jdunkerley added the CI: No changelog needed Do not require a changelog entry for this PR. label Aug 16, 2024
@jdunkerley jdunkerley marked this pull request as ready for review August 16, 2024 16:30
@jdunkerley jdunkerley added the CI: Ready to merge This PR is eligible for automatic merge label Aug 16, 2024
@mergify mergify bot merged commit 2dbdcb2 into develop Aug 16, 2024
37 checks passed
@mergify mergify bot deleted the wip/jd/aws-docs branch August 16, 2024 17:38
radeusgd
radeusgd reviewed Aug 16, 2024
View reviewed changes
distribution/lib/Standard/AWS/0.0.0-dev/src/Internal/S3_Path.enso
key = (without_prefix.drop first_slash_index+1)
normalized = Decomposed_S3_Path.parse key . normalize . key
S3_Path.Value bucket normalized
if uri.length == S3.uri_prefix.length then S3_Path.Value "" "" else
Copy link
Member

Choose a reason for hiding this comment

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

What does the empty s3:// path represent?

@unfurl-links unfurl-links bot mentioned this pull request Sep 3, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@radeusgd radeusgd radeusgd left review comments

@GregoryTravis GregoryTravis GregoryTravis approved these changes

@AdRiley AdRiley Awaiting requested review from AdRiley AdRiley is a code owner

@marthasharkey marthasharkey Awaiting requested review from marthasharkey marthasharkey is a code owner

Assignees
No one assigned
Labels
CI: No changelog needed Do not require a changelog entry for this PR. CI: Ready to merge This PR is eligible for automatic merge
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jdunkerley @radeusgd @GregoryTravis