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

[FEATURE] constructor documentation enhancement (VERY minor) #2087

Closed
jottinger opened this issue Apr 1, 2019 · 4 comments
Closed

[FEATURE] constructor documentation enhancement (VERY minor) #2087

jottinger opened this issue Apr 1, 2019 · 4 comments
Labels
parked Without further feedback this bug cannot be processed. If no feedback is provided, we close these.

Comments

@jottinger
Copy link

Describe the feature
This is a documentation enhancement.

@DaTa is documented as including @requiredargsconstructor as one of the implied annotations. However, if it finds constructors already in the code, it does not apply the @requiredargsconstructor, even if this would not clash with an already existing constructor. The documentation does not point this out.

Describe the target audience
Readers of the website.

@jottinger
Copy link
Author

In website/templates/constructor.html there's already text to this effect (in a parenthetical, see https://github.com/rzwitserloot/lombok/blob/master/website/templates/features/constructor.html#L12 . I'd suggest putting tags around the relevant phrase in the parenthetical, just for emphasis. I would be happy to submit a PR for this, but it's so minor that chances are it'd be discarded just to save disk space. :)

@jottinger
Copy link
Author

See also https://github.com/rzwitserloot/lombok/blob/master/website/templates/features/Data.html#L10 which is a better spot for an emphasis than in the constructor annotation documentation.

@rzwitserloot
Copy link
Collaborator

I'd say the highlighted line (L10 on Data.html) is.. just what you're asking for, no?

Should we mention it earlier (for example around line https://github.com/rzwitserloot/lombok/blob/master/website/templates/features/Data.html#L8 instead)?

@rzwitserloot rzwitserloot added the parked Without further feedback this bug cannot be processed. If no feedback is provided, we close these. label Apr 30, 2019
@rspilker
Copy link
Collaborator

No response from reporter, closing issue.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
parked Without further feedback this bug cannot be processed. If no feedback is provided, we close these.
Projects
None yet
Development

No branches or pull requests

3 participants