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

Every command should have example usage in --help #67

Closed
11 tasks done
simonw opened this issue Apr 14, 2022 · 2 comments
Closed
11 tasks done

Every command should have example usage in --help #67

simonw opened this issue Apr 14, 2022 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@simonw
Copy link
Owner

simonw commented Apr 14, 2022 •
edited
Loading

  • create
  • delete-user
  • get-object
  • list-bucket
  • list-buckets
  • list-roles
  • list-user-policies
  • list-users
  • policy
  • put-object
  • whoami
@simonw simonw added the documentation Improvements or additions to documentation label Apr 14, 2022
simonw added a commit that referenced this issue Apr 14, 2022
@simonw
Example usage for s3-credentials put-object --help, refs #67
5cbb861
@simonw
Copy link
Owner Author

simonw commented May 1, 2022

This will be easier to track if I use cog to include the full --help in the README - or in a separate help.md file because the README is getting pretty long already.

simonw added a commit that referenced this issue May 1, 2022
@simonw
help.md listing all help for commands, refs #67
eedf8e7
@simonw
Copy link
Owner Author

simonw commented May 1, 2022

Here's that new page: https://github.com/simonw/s3-credentials/blob/main/help.md

simonw added a commit that referenced this issue May 1, 2022
@simonw
Examples in --help for several commands, refs #67
e74e35d
@simonw simonw closed this as completed in 24c3dd6 May 1, 2022
simonw added a commit that referenced this issue May 1, 2022
@simonw
help.md listing all help for commands, refs #67
7988c7b
simonw added a commit that referenced this issue May 1, 2022
@simonw
Examples in --help for several commands, refs #67
495dc45
simonw added a commit that referenced this issue May 1, 2022
@simonw
Improved --help for remaining commands, closes #67
1f5f5c9
simonw added a commit that referenced this issue May 1, 2022
@simonw
set-cors-policy and get-cors-policy commands (#69)
6b54a5d 
* set-cors-policy and get-cors-policy commands, refs #47
* help.md listing all help for commands, refs #67
* Tests for get-cors-policy and set-cors-policy, refs #47
* Documentation for set-cors-policy and get-cors-policy, closes #47
simonw added a commit that referenced this issue May 1, 2022
@simonw
Release 0.11
3eca3a0 
Refs #47, #67, #69
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@simonw