From 556f8f18d46671613d41b985bd9f84bac60cd23a Mon Sep 17 00:00:00 2001 From: Pierre-Alexandre Veyry Date: Thu, 21 Dec 2023 22:21:19 +0100 Subject: [PATCH] repo: add .vscode to gitignore and add a few missing comments --- .gitignore | 2 ++ examples/scales_example.rs | 1 + src/lib.rs | 3 +++ 3 files changed, 6 insertions(+) diff --git a/.gitignore b/.gitignore index 088ba6b..deb3c05 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,5 @@ Cargo.lock # These are backup files generated by rustfmt **/*.rs.bk + +.vscode \ No newline at end of file diff --git a/examples/scales_example.rs b/examples/scales_example.rs index 557c362..ff64110 100644 --- a/examples/scales_example.rs +++ b/examples/scales_example.rs @@ -7,6 +7,7 @@ use rust_music::{ Instrument, Note, NoteName, Part, Phrase, Score, Tempo, }; +// This example requires the `composition` feature. fn main() -> Result<(), Box> { // Create a simple C Minor Scale on octave 4 (this requires the `composition` feature) let s = Scale::new( diff --git a/src/lib.rs b/src/lib.rs index 544f634..8c7c4ba 100644 --- a/src/lib.rs +++ b/src/lib.rs @@ -7,6 +7,9 @@ mod part; mod phrase; pub mod score; +// The `composition` feature enables the composition module which contains various +// utilities that simplify music composition, for example by streamlining the creation +// of common musical structures using music theory. #[cfg(feature = "composition")] pub mod composition;