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

Clarify "YAML Shortcomings" documentation #17933

anno1985 opened this issue Aug 22, 2019 · 0 comments


Copy link

commented Aug 22, 2019

The section on YAML Shortcomings in the docs on Externalized Configuration states:

Using the multi YAML document syntax in profile-specific YAML files can lead to unexpected behavior.

It goes on to give an example for "a file called application-dev.yml, with the dev profile being active":

  port: 8000
  profiles: !test
      password: weak

It concludes by stating:

In the example above, profile negation and profile expressions will not behave as expected.

However, it fails to mention what the actual result of the combination is, and why it would be unexpected. (It isn't explicitly stating what the author would have expected, so it's not clear what the actual/unexpected outcome would look like.)

It would be nice if the docs could be expanded to include what the issue/unexpected behaviour actually is.

@philwebb philwebb added this to the 2.1.x milestone Aug 22, 2019
@philwebb philwebb changed the title Section on YAML Shortcomings in Externalized Config docs is unclear Calify "YAML Shortcomings" documentation Aug 31, 2019
@philwebb philwebb changed the title Calify "YAML Shortcomings" documentation Clarify "YAML Shortcomings" documentation Aug 31, 2019
@philwebb philwebb closed this in 7e60f4b Aug 31, 2019
@philwebb philwebb modified the milestones: 2.1.x, 2.1.8 Aug 31, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
3 participants
You can’t perform that action at this time.