remove not-sane API

Author: molpopgen

src/sys/flags.rs

@@ -86,7 +86,7 @@ macro_rules! flags_api {
 /// Control the behavior of table simplification.
 ///
 /// Inclusion of values sets an option to `true`.
-/// The default behavior (`NONE`) is to perform the algorithm
+/// The default behavior is to perform the algorithm
 /// as described in Kelleher *et al.* (2018), 10.1371/journal.pcbi.1006581.
 ///
 /// The documentation for each field is taken from the `tskit` primary
@@ -101,7 +101,6 @@ macro_rules! flags_api {
 /// ```
 /// # use tskit::SimplificationOptions;
 /// let flags = SimplificationOptions::default();
-/// assert_eq!(flags, SimplificationOptions::NONE);
 /// ```
 ///
 /// ### Using a "builder" API
@@ -119,8 +118,6 @@ macro_rules! flags_api {
 pub struct SimplificationOptions(RawFlags);
 
 impl SimplificationOptions {
-    /// Default behavior
-    pub const NONE: Self = Self(0);
     make_constant_self!(=> FILTER_SITES, TSK_SIMPLIFY_FILTER_SITES);
     make_constant_self!(
     /// If True, remove any populations that are not referenced by
@@ -248,7 +245,6 @@ impl SimplificationOptions {
 /// ```
 /// # use tskit::TableClearOptions;
 /// let f = TableClearOptions::default();
-/// assert_eq!(f, TableClearOptions::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -285,8 +281,6 @@ impl SimplificationOptions {
 pub struct TableClearOptions(RawFlags);
 
 impl TableClearOptions {
-    /// Default behavior.
-    pub const NONE: Self = Self(0);
     make_constant_self!(=> CLEAR_METADATA_SCHEMAS,TSK_CLEAR_METADATA_SCHEMAS);
     make_constant_self!(=> CLEAR_TS_METADATA_SCHEMA, TSK_CLEAR_TS_METADATA_AND_SCHEMA);
     make_constant_self!(=> CLEAR_PROVENANCE,TSK_CLEAR_PROVENANCE);
@@ -313,7 +307,6 @@ impl TableClearOptions {
 /// ```
 /// # use tskit::TableEqualityOptions;
 /// let f = TableEqualityOptions::default();
-/// assert_eq!(f, TableEqualityOptions::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -358,8 +351,6 @@ impl TableClearOptions {
 pub struct TableEqualityOptions(RawFlags);
 
 impl TableEqualityOptions {
-    /// Default behavior.
-    pub const NONE: Self = Self(0);
     make_constant_self!(=> IGNORE_METADATA,TSK_CMP_IGNORE_METADATA);
     make_constant_self!(=>IGNORE_TS_METADATA, TSK_CMP_IGNORE_TS_METADATA);
     make_constant_self!(=> IGNORE_PROVENANCE,TSK_CMP_IGNORE_PROVENANCE);
@@ -390,7 +381,6 @@ impl TableEqualityOptions {
 /// ```
 /// # use tskit::TableSortOptions;
 /// let f = TableSortOptions::default();
-/// assert_eq!(f, TableSortOptions::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -407,8 +397,6 @@ impl TableEqualityOptions {
 pub struct TableSortOptions(RawFlags);
 
 impl TableSortOptions {
-    /// Default behavior.
-    pub const NONE: Self = Self(0);
     make_constant_self!(
     /// Do not validate contents of edge table.
     => NO_CHECK_INTEGRITY, TSK_NO_CHECK_INTEGRITY);
@@ -429,15 +417,12 @@ impl TableSortOptions {
 /// ```
 /// # use tskit::IndividualTableSortOptions;
 /// let f = IndividualTableSortOptions::default();
-/// assert_eq!(f, IndividualTableSortOptions::NONE);
 /// ```
 #[derive(Default, Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)]
 #[repr(transparent)]
 pub struct IndividualTableSortOptions(RawFlags);
 
 impl IndividualTableSortOptions {
-    /// Default behavior.
-    pub const NONE: Self = Self(0);
     bits!();
     all!();
     contains!();
@@ -453,7 +438,6 @@ impl IndividualTableSortOptions {
 /// ```
 /// # use tskit::TreeFlags;
 /// let f = TreeFlags::default();
-/// assert_eq!(f, TreeFlags::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -476,8 +460,6 @@ impl IndividualTableSortOptions {
 pub struct TreeFlags(RawFlags);
 
 impl TreeFlags {
-    /// Default behavior.
-    pub const NONE: Self = Self(0);
     make_constant_self!(
     /// Update sample lists, enabling [`Tree::samples`].
     => SAMPLE_LISTS,TSK_SAMPLE_LISTS);
@@ -537,7 +519,6 @@ impl TableOutputOptions {
 /// ```
 /// # use tskit::TreeSequenceFlags;
 /// let f = TreeSequenceFlags::default();
-/// assert_eq!(f, TreeSequenceFlags::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -555,8 +536,6 @@ impl TableOutputOptions {
 pub struct TreeSequenceFlags(RawFlags);
 
 impl TreeSequenceFlags {
-    /// Default behavior
-    pub const NONE: Self = Self(0);
     make_constant_self!(
     /// If used, then build table indexes if they are not present.
     => BUILD_INDEXES, TSK_TS_INIT_BUILD_INDEXES);
@@ -578,7 +557,6 @@ impl TreeSequenceFlags {
 /// ```
 /// # use tskit::TableIntegrityCheckFlags;
 /// let f = TableIntegrityCheckFlags::default();
-/// assert_eq!(f, TableIntegrityCheckFlags::NONE);
 /// ```
 ///
 /// ## Builder API
@@ -637,8 +615,6 @@ impl TreeSequenceFlags {
 pub struct TableIntegrityCheckFlags(RawFlags);
 
 impl TableIntegrityCheckFlags {
-    /// Default behavior is a set of basic checks
-    pub const NONE: Self = Self(0);
     make_constant_self!(
     /// Check that edges are ordered
      => CHECK_EDGE_ORDERING, TSK_CHECK_EDGE_ORDERING);
@@ -696,8 +672,6 @@ impl TableIntegrityCheckFlags {
 pub struct NodeFlags(tsk_flags_t);
 
 impl NodeFlags {
-    /// Default (empty)
-    pub const NONE: Self = Self(0);
     make_constant_self!(
         /// Node is a sample
         => IS_SAMPLE, TSK_NODE_IS_SAMPLE);
@@ -745,8 +719,6 @@ impl NodeFlags {
 pub struct IndividualFlags(RawFlags);
 
 impl IndividualFlags {
-    /// Default (empty)
-    pub const NONE: Self = Self(0);
     bits!();
     all!();
     contains!();
@@ -787,10 +759,8 @@ mod tests {
     fn default_looks_like_zero() {
         let n = NodeFlags::default();
         assert_eq!(n.bits(), 0);
-        assert!(n.contains(NodeFlags::NONE));
         let s = SimplificationOptions::default();
         assert_eq!(s.bits(), 0);
-        assert!(s.contains(SimplificationOptions::NONE));
     }
 
     #[test]