add documentation for error cases

signalapp / libsignal

Home to the Signal Protocol as well as other cryptographic primitives which make Signal possible.

GNU Affero General Public License v3.0

3.08k stars 362 forks source link

add documentation for error cases #471

Closed cosmicexplorer closed 6 months ago

cosmicexplorer commented 2 years ago

Broken out of #287.

While we have a terse description of each case of libsignal_protocol::Error to implement displaydoc::Display, we may also wish to have more in-depth explanation for the purposes of generated documentation. The #[ignore_extra_doc_attributes] flag enables us to provide this additional documentation while retaining the first line for the displaydoc::Display impl.

jrose-signal commented 2 years ago

(still on my todo list, but prose is harder to review than code!)