Merge pull request #11 from osrd-project/low_level_lrm

Add low level LrmScale implementation

Author: Tristramg

README.md

@@ -12,4 +12,10 @@ The schema is described in [schema/lrs.fbs](schema/lrs.fbs). The library is writ
 
 If your contribution changes the schema, you will need to generate the file with flatc. The version must be the release 23.5.26. Do not use a version built from master.
 
-`flatc -o src --rust schema/lrs.fbs`
+`flatc -o src --rust schema/lrs.fbs`
+
+## Norms
+
+### Comment convention
+
+See [How to write documentation in Rust](https://doc.rust-lang.org/rustdoc/how-to-write-documentation.html) to keep the code clean and clear (also [this](https://github.com/rust-lang/rfcs/blob/master/text/1574-more-api-documentation-conventions.md#appendix-a-full-conventions-text) for other examples).

src/curves.rs

@@ -13,7 +13,7 @@ use thiserror::Error;
 /// It provides basic primitives to locate/project points on it
 /// A curve can be part of a larger curve (e.g. for optimisation purpurses and have better bounding boxes)
 /// The curve can be implemented
-trait Curve {
+pub trait Curve {
     /// Project the point to the closest position on the curve
     /// Will fail if the curve is invalid (e.g. no points on it)
     /// or if the point is to far away

src/lib.rs

@@ -7,6 +7,8 @@ mod lrs_generated;
 
 #[deny(missing_docs)]
 pub mod curves;
+#[deny(missing_docs)]
+pub mod lrm_scale;
 pub use lrs_generated::*;
 
 #[test]