self_update icon indicating copy to clipboard operation
self_update copied to clipboard

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

Open fekie opened this issue 2 years ago • 2 comments

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.

fekie avatar Nov 04 '23 03:11 fekie

@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

jaemk avatar Nov 06 '23 02:11 jaemk

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

fekie avatar Nov 06 '23 03:11 fekie