Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix tense inconsistencies in doc comments #80

Open
stanleydesu opened this issue Oct 30, 2021 · 1 comment
Open

Fix tense inconsistencies in doc comments #80

stanleydesu opened this issue Oct 30, 2021 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@stanleydesu
Copy link
Collaborator

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 stanleydesu added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Oct 30, 2021
@sirinoks
Copy link

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

3 participants