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.

Sign up for GitHub

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

Jump to bottom

General Javadoc Improvements #250

Closed
3 tasks
Tracked by #246
lokka30 opened this issue Feb 1, 2023 · 0 comments
Closed
3 tasks
Tracked by #246

General Javadoc Improvements #250

lokka30 opened this issue Feb 1, 2023 · 0 comments
Assignees
@lokka30
Labels
core team task Task intended for the maintainers to complete, contributions not desired. priority: normal Normal priority status: confirmed Approved / validated type: documentation Changes to the documentation
Milestone
v2.0.0

Comments

@lokka30
Copy link
Member

lokka30 commented Feb 1, 2023 •
edited
Loading

Resolves part of #155.

  • In many javadocs we tell implementers to return something in the case of a failure occurring, when is expected (as per ). If something fails, we want to know why it failed, not some useless result value. The javadocs should be updated so that a is not expected if the given results in a failure.
  • In Account#hasPermission and Account#setPermission, clarify that the permissions array must contain at least one item.
  • In Account#retrievePermissions, clarify that ALL permissions must be returned, whether or not they are explicitly specified (so default = TriState.UNSPECIFIED)
@lokka30 lokka30 mentioned this issue Feb 1, 2023
Closed
16 tasks
@lokka30 lokka30 changed the title In many javadocs we tell implementers to return something in the case of a failure occurring, when is expected (as per ). If something fails, we want to know why it failed, not some useless result value. The javadocs should be updated so that a is not expected if the given results in a failure. General Javadoc Improvements Feb 1, 2023
@lokka30 lokka30 self-assigned this Feb 1, 2023
@lokka30 lokka30 added type: documentation Changes to the documentation priority: normal Normal priority status: confirmed Approved / validated core team task Task intended for the maintainers to complete, contributions not desired. labels Feb 1, 2023
@lokka30 lokka30 mentioned this issue Feb 1, 2023
Closed
8 tasks
@MrIvanPlays MrIvanPlays added this to the v2.0.0 milestone Feb 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@lokka30 lokka30

Labels
core team task Task intended for the maintainers to complete, contributions not desired. priority: normal Normal priority status: confirmed Approved / validated type: documentation Changes to the documentation
Projects
None yet
Milestone
v2.0.0
Development

No branches or pull requests
2 participants
@MrIvanPlays @lokka30