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.

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

Improve describing plugin parameters #683

Merged
merged 3 commits into from
Oct 26, 2015
Merged

Improve describing plugin parameters #683

merged 3 commits into from
Oct 26, 2015

Conversation

okkez
Copy link
Contributor

@okkez okkez commented Oct 16, 2015

We can write long description easily.

We can write description of plugin parameter as following:

```
class Fluent::SomeInput < Fluent::Input
  config_set_desc :tag, "This value is the tag assigned to the generated events."
  config_param :tag, :string
end
```
We can write description of plugin parameter as following:

```
class Fluent::SomeInput < Fluent::Input
  desc "This value is the tag assigned to the generated events."
  config_param :tag, :string
end
```
repeatedly added a commit that referenced this pull request Oct 26, 2015
Improve describing plugin parameters
@repeatedly repeatedly merged commit 48ce263 into fluent:master Oct 26, 2015
@repeatedly
Copy link
Member

Good 👍

@okkez
Copy link
Contributor Author

okkez commented Oct 26, 2015

Thank you!!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants