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

Reconsider config object names #199

Open
colmsnowplow opened this issue Aug 15, 2022 · 1 comment
Open

Reconsider config object names #199

colmsnowplow opened this issue Aug 15, 2022 · 1 comment

Comments

@colmsnowplow
Copy link
Collaborator

For sources, where we have fully segmented configs into their pkg, we name all the config objects configuration. This made the linter stop complaining about verbose names.

Elsewhere, we have some inconsistent names (eg. KafkaConfig and HTTPTargetConfig for the Kafka and HTTP targets, respectively).

Thinking about clear documentation for the project, we should do something about both of these, and consider making all configuration options have a consistent name which specifies exactly what the config is for. That would play nicely with automating API docs using go doc or similar tools.

I don't mind going against the linter's wishes if it gives us better/easier to maintain documentation.

@colmsnowplow
Copy link
Collaborator Author

Additionally, for sources (and when we get round to doing similar to the others), even though configuration objects don't need to be public, if making them public might provide some value from a documentation perspective, then they should be public.

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

No branches or pull requests

1 participant