jaemk / self_update

Self updates for rust executables
MIT License
798 stars 70 forks source link

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

Open fekie opened 1 year ago

fekie commented 1 year ago

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 commented 1 year ago

@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 commented 1 year ago

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