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

Improve API docs on ErrorDefinitions #404

Closed
funkyfuture opened this issue Jun 4, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@funkyfuture
Copy link
Member

commented Jun 4, 2018

Used Cerberus version / latest commit: any

  • I have the capacity to improve the docs when my problem is solved.

  • I have the capacity to submit a patch when a bug is identified.

  • My question does not concern a practical use-case that I can't figure out
    to solve.


Bug report

the api docs exclude error definitions that are not assigned to a distinct rule. that's quark.

on that occasion, the semantics of the codes' bits should be documented better and bits that are safe to use for customizations should be declared (mind different notations!). ther might be an open issue related to the latter.

@funkyfuture funkyfuture added this to the 1.2.1 milestone Jun 4, 2018

@funkyfuture funkyfuture self-assigned this Jun 4, 2018

funkyfuture added a commit to funkyfuture/cerberus that referenced this issue Jun 7, 2018

Includes all error definition in the API docs
Also elaborates on the reserved and recommended bits of error codes.

Closes pyeve#404.

funkyfuture added a commit that referenced this issue Jan 27, 2019

Includes all error definition in the API docs
Also elaborates on the reserved and recommended bits of error codes.

Closes #404.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.