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.

Sign up for GitHub

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

Jump to bottom

Confdocs can't parse array examples correctly #1638

Open
charithe opened this issue Jun 12, 2023 · 1 comment
Open

Confdocs can't parse array examples correctly #1638

charithe opened this issue Jun 12, 2023 · 1 comment
Labels
area/tooling Tools for automating project chores kind/bug Something isn't working

Comments

@charithe
Copy link
Contributor

Given this configuration:

Compression []string `yaml:"compression" conf:",example=['zstd', 'snappy', 'none']"`

The parser stops at the first comma and produces an incomplete example.

compression: ['zstd' # Compression sets the compression algorithm to use in order of priority. Valid values are "none", "gzip", "snappy","lz4", "zstd". Default is ["snappy", "none"].
@charithe charithe added kind/bug Something isn't working area/tooling Tools for automating project chores labels Jun 12, 2023
@charithe charithe mentioned this issue Jun 12, 2023
Merged
3 tasks
@charithe
Copy link
Contributor Author

I wonder if https://github.com/matt1484/spectagular might be useful for this.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/tooling Tools for automating project chores kind/bug Something isn't working
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@charithe