CubeSimRS icon indicating copy to clipboard operation
CubeSimRS copied to clipboard

Fix tense inconsistencies in doc comments

Open stanleydesu opened this issue 2 years ago • 1 comments

I see some inconsistencies in tense (present and past) in some doc comments (currently detected in generic_cube.rs). E.g.

/// Maps over the pieces of the cube, replacing each piece
/// according to the given mask function. 
fn mask(&self, mask: &dyn Fn(i32, Face) -> Face) -> Self;

/// Apply a move to a cube.
/// ...
fn apply_move(&self, mv: Move) -> Self;

stanleydesu avatar Oct 30 '21 07:10 stanleydesu

I would like to work on this. What tense should it be out of the two?

sirinoks avatar Oct 30 '21 13:10 sirinoks