Add descriptions to out_file plugin parameters #701
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
| config_param :append, :bool, :default => false | ||
| desc "Compress chunks with specified compression algorithm." |
There was a problem hiding this comment.
Document says "Compresses flushed files using gzip.".
Should I use this one or your suggestion?
There was a problem hiding this comment.
No. For this, docs should be fixed (not always gzip)
There was a problem hiding this comment.
Hmm..., OK I'll fix this line with your suggestion.
There was a problem hiding this comment.
Ah, let me write more descriptive.
Currently, out_file supports only gzip, so Compresses flushed files using gzip is not wrong, but I think
Compress flushed file with specified compression algorithm.
is fine. In addition, documents should list what algorithms can be specified.
|
Could you use same words with doc? http://docs.fluentd.org/articles/out_file |
repeatedly
added a commit
that referenced
this pull request
Nov 13, 2015
Add descriptions to out_file plugin parameters
repeatedly
added a commit
that referenced
this pull request
Dec 8, 2015
Add descriptions to out_file plugin parameters
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.
I tried to add descriptions in out_file plugin.
Related to #584.