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

Add error and panic documentation #40

Closed
V0ldek opened this issue Nov 13, 2022 · 0 comments
Closed

Add error and panic documentation #40

V0ldek opened this issue Nov 13, 2022 · 0 comments
Assignees
@V0ldek
Labels
area: library Improvements to the library API quality type: documentation Improvements or additions to documentation
Milestone
v1.0.0

Comments

@V0ldek
Copy link
Member

V0ldek commented Nov 13, 2022

Is your feature request related to a problem? Please describe.
We should document all places where an error can occur in library code.

Describe the solution you'd like
Enable clippy::missing_errors_doc and clippy::missing_panics_doc doc lints and fix all occurrences.
@V0ldek V0ldek added type: documentation Improvements or additions to documentation acceptance: go ahead Reviewed, implementation can start acceptance: triage Waiting for owner's input labels Nov 13, 2022
@V0ldek V0ldek self-assigned this Nov 13, 2022
@V0ldek V0ldek added this to the v1.0.0 milestone Nov 13, 2022
@V0ldek V0ldek added error handling and removed acceptance: triage Waiting for owner's input labels Nov 13, 2022
@V0ldek V0ldek mentioned this issue Nov 13, 2022
Closed
3 tasks
@V0ldek V0ldek added area: library Improvements to the library API quality mod: engine and removed type: error handling labels Nov 23, 2022
@V0ldek V0ldek mentioned this issue Dec 14, 2022
Merged
V0ldek added a commit that referenced this issue Dec 14, 2022
@V0ldek
lib: panic-free classifiers and engines
7a19d1a 
Detectable errors now use proper error types instead of panics.
Added lints to prevent adding more panics or undocumented errors.

Related: #39, #40, #31
@V0ldek V0ldek closed this as completed Dec 14, 2022
@github-actions github-actions bot removed the acceptance: go ahead Reviewed, implementation can start label Dec 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@V0ldek V0ldek

Labels
area: library Improvements to the library API quality type: documentation Improvements or additions to documentation
Projects
Active rq development
Status: Released
Milestone
v1.0.0
Development

No branches or pull requests
1 participant
@V0ldek