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 documentation of configuration properties with type Map<String, NotAConfigGroup> #40332

Closed
yrodiere opened this issue Apr 29, 2024 · 1 comment · Fixed by #40335
Closed
Assignees
Milestone

Comments

@yrodiere
Copy link
Member

Description

Configuration properties of type Map<String, SomeConfigGroup>, where SomeConfigGroup is a type annotated with @ConfigGroup are handled nicely, with documentation clearly stating that the map key is included in the configuration property key:

image

The name of the map key in the documentation can even be customized with @ConfigDocMapKey("someName").

On the other hand, configuration properties of type Map<String, NotAConfigGroup>, where NotAConfigGroup is a type that is not annotated with @ConfigGroup, are not handled nicely at all:

image

Also, adding @ConfigDocMapKey("someName") on such properties has no effect.

We should display Maps the same way in the documentation, regardless of whether the value type is a config group or not.

Implementation ideas

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
1 participant