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

[BUG] Incorrect Documentation for lombok.noArgsConstructor.extraPrivate #2377

Closed
urda opened this issue Feb 26, 2020 · 2 comments
Closed

[BUG] Incorrect Documentation for lombok.noArgsConstructor.extraPrivate #2377

urda opened this issue Feb 26, 2020 · 2 comments

Comments

@urda
Copy link

urda commented Feb 26, 2020

Describe the bug

According to https://projectlombok.org/changelog one can see:

BREAKING CHANGE: The in 1.16.22 introduced configuration key lombok.noArgsConstructor.extraPrivate is now false by default. Issue #1708

However the API documentation reports:

https://github.com/rzwitserloot/lombok/blob/7993aa20cd20cdc030f90ee9f33c1b74c023d7ca/src/core/lombok/ConfigurationKeys.java#L166-L171

that this defaults to true. This appears to be out-of-date and needs to be corrected.

To Reproduce

  1. Read https://projectlombok.org/changelog and see "configuration key lombok.noArgsConstructor.extraPrivate is now false by default" as a bullet point.
  2. Open https://projectlombok.org/api/lombok/ConfigurationKeys.html#NO_ARGS_CONSTRUCTOR_EXTRA_PRIVATE and see that the API docs do not agree.

Expected behavior

changelog and API documentation needs to agree.

Additional Info and Related Issues

  • This config change burned my team during some upgrades, the addition of mismatched documentation and changelogs did not help either.
  • Issue extraPrivate=true from 1.16.22 breaks Jackson creator detection #1708 helped ID the config change we needed, which lead us to the API mismatch in the docs.
  • I would have cut a PR myself but do not have my GitHub keys on this machine today.
@rzwitserloot
Copy link
Collaborator

@urda ha, documentation always lead to funny reproduction/expected behaviour stories. I'll write that one up to humorous malicious compliance that you bothered to write something for those sections :)

I'll get right on this, easy enough to address.

@rzwitserloot
Copy link
Collaborator

While I was there, I now documented these keys on constructor, [value]((https://projectlombok.org/features/value), and data's docs.

Febell pushed a commit to Febell/lombok that referenced this issue Mar 1, 2020
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

2 participants