Skip to content

Commit

Permalink
docs: updated docs (#43)
Browse files Browse the repository at this point in the history
Forgot to update docs in #41.

I actually don't know if it's legal to link to another crate's docs as I
did here for the `Case` enum. Let me know if crates.io rejects this or
whatever.
  • Loading branch information
Yag000 authored Dec 2, 2024
2 parents fe0ceba + 914cc84 commit ed45972
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 2 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ variants and also changing the case of the string representation.
use enum_stringify::EnumStringify;

#[derive(EnumStringify)]
#[enum_stringify(prefix = "MyPrefix", suffix = "MySuffix", case = "upper")]
#[enum_stringify(prefix = "MyPrefix", suffix = "MySuffix", case = "upper_flat")]
enum MyEnum {
Variant1,
Variant2,
Expand Down
5 changes: 4 additions & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,10 @@ mod attributes;
///
/// # Case
///
/// You can also set the case ("lower" or "upper") of the string representation of the enum variants.
/// You can also set the case of the string representation of the enum variants.
/// Case conversion is provided by the [`convert_case`] crate. Refer to the variants
/// of the [`convert_case::Case`] enum for options (expressed in lower snake case).
/// The exception are the `Random` and `PseudoRandom` variants, which are not accepted.
///
/// ```
/// use enum_stringify::EnumStringify;
Expand Down

0 comments on commit ed45972

Please sign in to comment.