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

Fix some documentation and names #80

Closed
MrNemo64 opened this issue Dec 20, 2021 · 1 comment
Closed

Fix some documentation and names #80

MrNemo64 opened this issue Dec 20, 2021 · 1 comment
Assignees
Labels
help wanted Requires contributor help to solve. priority: normal Normal priority status: confirmed Approved / validated type: documentation Changes to the documentation type: improvement A feature is added or adjusted

Comments

@MrNemo64
Copy link
Contributor

MrNemo64 commented Dec 20, 2021

In the description of this entry of FEATURE_NOT_SUPPORTED it is said

It is paramount that plugins ensure that economy providers support certain methods (e.g. bank accounts) before attempting to access them.

yet NonPlayerAccounts are no longer an optional feature

In Acount#setBalance it is said

Specified amounts must be AT OR ABOVE zero.

yet the provider may optionally support negative balances (OptionalEconomyApiFeature#NEGATIVE_BALANCES)

We have 2 packages for common clases between APIs: me.lokka30.treasury.api.common and me.lokka30.treasury.api.misc

There are most likely some more inconcistencies in the code/documentation but these are the ones that I had time to find. We should probably do a full scan of the code after the PR are closed to find these mistakes

EDIT: some more things I found
EconomyFailureReason#ACCOUNT_DELETION_NOT_SUPPORTED but account deletion is not an optional feature
EconomyFailureReason#ALREADY_MEMBER_OF_ACCOUNT and EconomyFailureReason#ALREADY_NOT_MEMBER_OF_ACCOUNT but we no longer have an addMember method, members now are defined by permissions
EconomyFailureReason#ALREADY_OWNER_OF_ACCOUNT and EconomyFailureReason#ALREADY_NOT_OWNER_OF_ACCOUNT we no longer have owners

@lokka30
Copy link
Member

lokka30 commented Dec 20, 2021

Thanks for finding these

@lokka30 lokka30 self-assigned this Dec 20, 2021
@lokka30 lokka30 added status: confirmed Approved / validated type: documentation Changes to the documentation type: improvement A feature is added or adjusted help wanted Requires contributor help to solve. priority: normal Normal priority labels Dec 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
help wanted Requires contributor help to solve. priority: normal Normal priority status: confirmed Approved / validated type: documentation Changes to the documentation type: improvement A feature is added or adjusted
Projects
None yet
Development

No branches or pull requests

2 participants