Improve upload_dir command help strings#66
Merged
const-cloudinary merged 2 commits intomasterfrom Feb 7, 2023
Merged
Conversation
carlevison
approved these changes
Feb 7, 2023
Collaborator
carlevison
left a comment
There was a problem hiding this comment.
Suggested a change to the wording, otherwise approved.
Co-authored-by: carlevison <54800761+carlevison@users.noreply.github.com>
This file contains hidden or 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
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.
Brief Summary of Changes
This PR started from the review of: #63
@jackieros suggested to improve doc strings of
--folderparameter (written in the comment to that PR).In addition this PR shortens the doc string of the newly added
--exclude-dir-nameparameter( as @jackieros suggested)I still think those doc strings are a bit too long and are becoming overcomplicated when writing the difference between dynamic folder environment vs classic.
I'm pretty sure 99% of our customers have no idea what that thing is about.
I would suggest to write a guide/article/reference that would explain how to work with dynamic folders in one page.
And if dynamic folders will be our default approach, so the opposite, remove legacy doc strings.
In addition
--docoption was added, it points to the documentation page, where we can provide all the details.What does this PR address?
Are tests included?
Reviewer, please note:
Checklist: