Doc has incorrect description in RemoveObjects API #846
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
poornas
approved these changes
Oct 12, 2017
krisis
reviewed
Oct 13, 2017
docs/API.md
Outdated
| @@ -945,7 +945,7 @@ __Parameters__ | |||
| |Param |Type |Description | | |||
| |:---|:---| :---| | |||
| |`bucketName` | _string_ |Name of the bucket | | |||
| |`objectsCh` | _chan string_ | Prefix of objects to be removed | | |||
| |`objectsCh` | _chan string_ | List of objects to be removed | | |||
|
|
|||
There was a problem hiding this comment.
Channel of objects to removed would be more precise.
Description for parameter objectsCh in the RemoveObjects API is incorrect. It is being changed from "Prefix of objects to be removed" to "Channel of objects to be removed". Fixes minio#845
kannappanr
force-pushed
the
incorrect_description
branch
from
0a28704
to
d806f9e
Compare
krisis
approved these changes
Oct 13, 2017
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 for parameter objectsCh in the RemoveObjects API
is incorrect.
It is being changed from "Prefix of objects to be removed" to
"List of objects to be removed".
Fixes #845