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

Confusing javadoc in YamlProcessor.setDocumentMatchers [SPR-16849] #21389

Closed
spring-issuemaster opened this Issue May 21, 2018 · 0 comments

Comments

Projects
None yet
2 participants
@spring-issuemaster
Copy link
Collaborator

spring-issuemaster commented May 21, 2018

Georgios Andrianakis opened SPR-16849 and commented

Currently the Javadoc of YamlProcessor.setDocumentMatchers states, that it can be used with something like:

 

YamlProcessor.mapMatcher({"environment": "prod"})

 

 which is somewhat confusing since mapMatcher is not a method of YamlProcessor. 

I propose that the javadoc shows a use case like the one that is used in the tests (see here

I can of course create a PR for this if it's something that you deem is worth changing

 

Thanks


Affects: 4.3.17, 5.0.6

Reference URL:

* <code>documentMatchers = YamlProcessor.mapMatcher({"environment": "prod"})</code>

Referenced from: commits 455d8ac, 357ca21, 7ece0e2

Backported to: 4.3.18

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