Skip to content

Commit

Permalink
unstable api
Browse files Browse the repository at this point in the history
  • Loading branch information
mwlon committed Nov 9, 2024
1 parent e11d165 commit c3768ed
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 11 deletions.
4 changes: 2 additions & 2 deletions pco/src/data_types/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ pub(crate) trait Float:
fn from_latent_numerical(l: Self::L) -> Self;
}

/// *unstable API* Trait for data types that behave like unsigned integers.
/// **unstable API** Trait for data types that behave like unsigned integers.
///
/// This is used extensively in `pco` to guarantee that bitwise
/// operations like `>>` and `|=` are available and that certain properties
Expand Down Expand Up @@ -132,7 +132,7 @@ pub trait Latent:
}
}

/// *unstable API* Trait for data types supported for compression/decompression.
/// **unstable API** Trait for data types supported for compression/decompression.
///
/// If you have a new data type you would like to add to the library or,
/// these are the questions you need to answer:
Expand Down
10 changes: 1 addition & 9 deletions pco/src/macros.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

dtype_dispatch::build_dtype_macros!(
#[doc = "\
Defines enums holding a container generic to `Number`.
**unstable API** Defines enums holding a container generic to `Number`.
"]
#[doc = "\
You'll only want to use this if you're using pco's low level APIs.
Expand Down Expand Up @@ -37,14 +37,6 @@ dtype_dispatch::build_dtype_macros!(
);

dtype_dispatch::build_dtype_macros!(
#[doc = "\
Defines enums holding a container generic to `Latent`.
"]
#[doc = "\
You'll only want to use this if you're using pco's low level APIs.
See the dtype_dispatch crate for more details.
"]
#[macro_export]
define_latent_enum,

#[doc = "\
Expand Down

0 comments on commit c3768ed

Please sign in to comment.