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

Documentation Request: Add Documentation for Enum Variants of self_update::errors::Error #118

Open
fekie opened this issue Nov 4, 2023 · 2 comments · May be fixed by #119
Open

Documentation Request: Add Documentation for Enum Variants of self_update::errors::Error #118

fekie opened this issue Nov 4, 2023 · 2 comments · May be fixed by #119

Comments

@fekie
Copy link

fekie commented Nov 4, 2023

Version

v0.39.0

Description

self_update::errors::Error is the error value that can be returned from updated_extended() and it does not contain documentation and it is non-obvious as to what each each enum represents. For example, there is an Update enum but it is not clear if this has anything to do with a successful update already occurring or if there is a recoverable or unrecoverable update error.
@jaemk
Copy link
Owner

jaemk commented Nov 6, 2023

@Chloe-Woahie thanks for pointing this out. The Error variants definitely need some documentation. A PR is welcome if you have time before I do

@fekie
Copy link
Author

fekie commented Nov 6, 2023

Alright, will try to work on it when I get some time

@fekie fekie linked a pull request Nov 7, 2023 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add error documentation fekie/self_update
2 participants
@jaemk @fekie