docs(docs): in-code fixes for documentation

This commit is contained in:
Scott Lyons 2024-09-05 13:43:08 -07:00
commit 3611849c00
11 changed files with 1523 additions and 193 deletions

View file

@ -57,7 +57,7 @@ pub enum SzurubooruClientError {
#[error("JSON Serialization error: {0}")]
JSONSerializationError(#[source] serde_json::Error),
/// Error when validation fails for one of the Builder types
#[error("Vlidation error: {0}")]
#[error("Validation error: {0}")]
ValidationError(String),
/// Error occurred when reading a file
#[error("IO Error: {0}")]
@ -80,12 +80,17 @@ impl From<UninitializedFieldError> for SzurubooruClientError {
}
#[cfg(feature = "python")]
create_exception!(szurubooru_client, SzuruPyClientError, PyException);
create_exception!(
szurubooru_client,
SzuruClientError,
PyException,
"An exception that contains two pieces of information: The error kind and error details"
);
#[cfg(feature = "python")]
impl std::convert::From<SzurubooruClientError> for PyErr {
fn from(value: SzurubooruClientError) -> Self {
SzuruPyClientError::new_err((value.as_ref().to_string(), value.to_string()))
SzuruClientError::new_err((value.as_ref().to_string(), value.to_string()))
}
}