Merge pull request #110 from light-curve/const-doc-method

Make doc() static methods constant

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - **Build breaking** Minimum supported Rust version (MSRV) 1.57 -> 1.65 (released 2022-11-03)
+- Feature's `doc()` static method is `const` now
 
 ### Deprecated
 

src/extractor.rs

@@ -79,7 +79,7 @@ where
 }
 
 impl<T, F> FeatureExtractor<T, F> {
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/amplitude.rs

@@ -33,7 +33,7 @@ impl Amplitude {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/anderson_darling_normal.rs

@@ -32,7 +32,7 @@ impl AndersonDarlingNormal {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/bazin_fit.rs

@@ -85,7 +85,7 @@ impl BazinFit {
         BazinInitsBounds::Default
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/beyond_n_std.rs

@@ -79,7 +79,7 @@ where
 }
 
 impl<T> BeyondNStd<T> {
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/bins.rs

@@ -130,7 +130,7 @@ where
     T: Float,
     F: FeatureEvaluator<T>,
 {
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 

src/features/cusum.rs

@@ -32,7 +32,7 @@ impl Cusum {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/duration.rs

@@ -25,7 +25,7 @@ impl Duration {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/eta.rs

@@ -28,7 +28,7 @@ impl Eta {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/eta_e.rs

@@ -33,7 +33,7 @@ impl EtaE {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/excess_variance.rs

@@ -39,7 +39,7 @@ impl ExcessVariance {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/inter_percentile_range.rs

@@ -66,7 +66,7 @@ impl InterPercentileRange {
         0.25
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/kurtosis.rs

@@ -29,7 +29,7 @@ impl Kurtosis {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/linear_fit.rs

@@ -31,7 +31,7 @@ impl LinearFit {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/linear_trend.rs

@@ -29,7 +29,7 @@ impl LinearTrend {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/magnitude_percentage_ratio.rs

@@ -85,7 +85,7 @@ impl MagnitudePercentageRatio {
         0.05
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/maximum_slope.rs

@@ -40,7 +40,7 @@ impl MaximumSlope {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/maximum_time_interval.rs

@@ -26,7 +26,7 @@ impl MaximumTimeInterval {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/mean.rs

@@ -35,7 +35,7 @@ impl Mean {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/mean_variance.rs

@@ -34,7 +34,7 @@ impl MeanVariance {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/median.rs

@@ -34,7 +34,7 @@ impl Median {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/median_absolute_deviation.rs

@@ -37,7 +37,7 @@ impl MedianAbsoluteDeviation {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/median_buffer_range_percentage.rs

@@ -71,7 +71,7 @@ where
 }
 
 impl<T> MedianBufferRangePercentage<T> {
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/minimum_time_interval.rs

@@ -26,7 +26,7 @@ impl MinimumTimeInterval {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/observation_count.rs

@@ -25,7 +25,7 @@ impl ObservationCount {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/otsu_split.rs

@@ -43,7 +43,7 @@ impl OtsuSplit {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 

src/features/percent_amplitude.rs

@@ -37,7 +37,7 @@ impl PercentAmplitude {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/percent_difference_magnitude_percentile.rs

@@ -69,7 +69,7 @@ impl PercentDifferenceMagnitudePercentile {
         0.05
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/periodogram.rs

@@ -86,7 +86,7 @@ impl PeriodogramPeaks {
         1
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         PERIODOGRAM_PEAK_DOC
     }
 }
@@ -347,7 +347,7 @@ impl<T, F> Periodogram<T, F>
 where
     T: Float,
 {
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/reduced_chi2.rs

@@ -40,7 +40,7 @@ impl ReducedChi2 {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/skew.rs

@@ -39,7 +39,7 @@ impl Skew {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/standard_deviation.rs

@@ -39,7 +39,7 @@ impl StandardDeviation {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/stetson_k.rs

@@ -41,7 +41,7 @@ impl StetsonK {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/time_mean.rs

@@ -25,7 +25,7 @@ impl TimeMean {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/time_standard_deviation.rs

@@ -25,7 +25,7 @@ impl TimeStandardDeviation {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/features/transformed.rs

@@ -69,7 +69,7 @@ where
         })
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC!()
     }
 }

src/features/villar_fit.rs

@@ -89,7 +89,7 @@ impl VillarFit {
         VillarInitsBounds::Default
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 

src/features/weighted_mean.rs

@@ -35,7 +35,7 @@ impl WeightedMean {
         Self {}
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/tests.rs

@@ -323,10 +323,10 @@ macro_rules! check_doc_static_method {
     ($name: ident, $feature: ty) => {
         #[test]
         fn $name() {
-            let doc = <$feature>::doc();
-            assert!(doc.contains("Depends on: "));
-            assert!(doc.contains("Minimum number of observations: "));
-            assert!(doc.contains("Number of features: "));
+            const DOC: &'static str = <$feature>::doc();
+            assert!(DOC.contains("Depends on: "));
+            assert!(DOC.contains("Minimum number of observations: "));
+            assert!(DOC.contains("Number of features: "));
         }
     };
 }

src/transformers/bazin_fit.rs

@@ -41,7 +41,7 @@ where
         8.9_f32.value_into().unwrap()
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }
 }

src/transformers/clipped_lg.rs

@@ -27,7 +27,7 @@ where
         f64::MIN_POSITIVE.log10().approx().unwrap()
     }
 
-    pub fn doc() -> &'static str {
+    pub const fn doc() -> &'static str {
         DOC
     }