Skip to content

Commit

Permalink
Improve comments and use stable toolchain again (#295)
Browse files Browse the repository at this point in the history
  • Loading branch information
martinmr committed Feb 12, 2024
1 parent 2de8f4d commit 32dc59e
Show file tree
Hide file tree
Showing 4 changed files with 11 additions and 13 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ jobs:
- name: Install stable toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: 1.73.0
toolchain: stable

- name: Setup Rust cache
uses: Swatinem/rust-cache@v2
Expand All @@ -36,7 +36,7 @@ jobs:
- name: Install stable toolchain
uses: dtolnay/rust-toolchain@master
with:
toolchain: 1.73.0
toolchain: stable

- name: Install extra components
run: rustup component add clippy rust-docs rustfmt
Expand Down
1 change: 1 addition & 0 deletions ffi/trane.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
Generated by typeshare 1.7.0
*/
exports.__esModule = true;
exports.UnitType = exports.MasteryScore = exports.FilterType = exports.FilterOp = exports.ExerciseType = void 0;
var ExerciseType;
(function (ExerciseType) {
ExerciseType["Declarative"] = "Declarative";
Expand Down
15 changes: 6 additions & 9 deletions src/data/course_generator/transcription.rs
Original file line number Diff line number Diff line change
@@ -1,12 +1,9 @@
//! Defines a special course to teach transcription based on a set of musical passages.
//!
//! This course generator is similar to the improvisation course generator, but the passages are
//! provided as actual musical recordings instead of music sheet. The student is expected to listen
//! to the passages to internalize the sounds, and then transcribe the passages to their instruments
//! and use them as a basis for improvisation. It is not required to use solfege syllables or
//! numbers nor to notate the passages. This course is meant to replicate the process of listenting
//! and imitation that is used in traditional music education and eventually became the method on
//! which Jazz was aurally transmitted.
//! The student is expected to listen to the passages to internalize the sounds, and then transcribe
//! the passages to their instruments and use them as a basis for improvisation. This course is
//! meant to replicate the process of listenting and imitation that is at the heart of the
//! transmitions of aural music traditions, such as Jazz.

pub mod constants;

Expand Down Expand Up @@ -97,8 +94,8 @@ pub struct TranscriptionPassages {
pub asset: TranscriptionAsset,

/// The ranges `[start, end]` of the passages to transcribe. Stored as a map maping a unique ID
/// to the start and end of the passage. A map is used to get the indices instead of getting
/// them from a vector because reordering the passages would change the resulting exercise IDs.
/// to the start and end of the passage. A map is used instead of a list because reordering the
/// passages would change the resulting exercise IDs.
pub intervals: HashMap<usize, (String, String)>,
}
//>@transcription-passages
Expand Down
4 changes: 2 additions & 2 deletions tests/transcription_tests.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ lazy_static! {
};
}

/// Returns a course builder with an improvisation generator.
/// Returns a course builder with an transcription generator.
fn transcription_builder(
course_id: Ustr,
course_index: usize,
Expand Down Expand Up @@ -110,7 +110,7 @@ fn transcription_builder(
}
}

/// Verifies that all improvisation exercises are visited.
/// Verifies that all transcription exercises are visited.
#[test]
fn all_exercises_visited() -> Result<()> {
// Initialize test course library.
Expand Down

0 comments on commit 32dc59e

Please sign in to comment.