Conversation
|
Is the intention/scope of this PR to remove every use of "please" and "please note" in the manual? |
No, it does not remove every "please". From the guide: Use please only when you're asking for permission or forgiveness—for example, when what you're asking for benefits you, inconveniences a reader, or suggests a potential issue with a product. Therefore, it still preserves it in situations mentioned in the guide. e.g. If you've encountered a bug, please follow ... |
GithubAnon0000
left a comment
There was a problem hiding this comment.
Aside from my one comment, looks good to me.
src/deck-options.md
Outdated
| Parameters and desired retention are preset-specific, you can make multiple presets with different parameters and desired retention. | ||
|
|
||
| FSRS can adapt to almost any habit, except for one: pressing "Hard" instead of "Again" when you forget the information. When you press "Hard", FSRS assumes you have recalled the information correctly (though with hesitation and a lot of mental effort). If you press "Hard" when you have failed to recall the information, all intervals will be unreasonably high. So, if you have this habit, please change it and use "Again" when you forget the information. | ||
| FSRS can adapt to almost any habit, except for one: pressing "Hard" instead of "Again" when you forget the information. When you press "Hard", FSRS assumes you have recalled the information correctly (though with hesitation and a lot of mental effort). If you press "Hard" when you have failed to recall the information, all intervals will be unreasonably high. So, if you have this habit, change it and use "Again" when you forget the information. |
There was a problem hiding this comment.
Since you said this:
From the guide: Use please only when you're asking for permission or forgiveness—for example, when what you're asking for benefits you, inconveniences a reader, or suggests a potential issue with a product.
Changing habits (even if the user was in the wrong to beginn with) probably falls under "inconveniences a reader". I'm not saying we necessarily need a please here, but it might be appropriate anyways. Especially since it seems a bit rude without "please" given the way the sentence is written.
There was a problem hiding this comment.
Agreed, I'll revert this one, thanks
4c76697 to
4da2862
Compare
Resolves #419
This removes unnecessary uses of the word "please" from the manual.
It follows the guidance from the Google Developer Style Guide