DOCSP-48522-update-mongosh-history-log-description #394
Conversation
✅ Deploy Preview for docs-mongodb-shell ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Thanks for picking this up @amalhotra-mdb! Just a couple small comments.
| @@ -103,12 +103,16 @@ | |||
| * - ``redactHistory`` | |||
| - string | |||
| - ``remove`` | |||
| - Controls what information is recorded in the shell history. | |||
| - Controls what information is recorded in the ``mongosh`` command history, | |||
| meaning what can be accessed via up and down keys and Ctrl+R while inside the shell. | |||
There was a problem hiding this comment.
[suggestion] Instead of using a dependent clause here, I think we can just split this up into separate sentences to make it more concise/simple. Maybe something like:
Controls what information is recorded in the `mongosh` command history. You can access the `mongosh` command history via the up and down...
| - Controls what information is recorded in the shell history. | ||
| - Controls what information is recorded in the ``mongosh`` command history, | ||
| meaning what can be accessed via up and down keys and Ctrl+R while inside the shell. | ||
|
|
||
| Must be one of: |
There was a problem hiding this comment.
[suggestion] I know you didn't make this change, but it might be clearer if this introductory text doesn't end with a preposition
| Must be one of: | |
| Must be one of the following values: |
| Must be one of: | ||
| - Controls what information is recorded in the ``mongosh`` command history. | ||
| You can access the ``mongosh`` command history via the up and down keys | ||
| and Ctrl+R while inside the shell. |
There was a problem hiding this comment.
[question/nit] Should we say "or" here since the Ctrl + R search mechanism in mongosh is separate from the up & down key navigation of the command history?
| and Ctrl+R while inside the shell. | |
| or Ctrl+R while inside the shell. |
DESCRIPTION
Update mongosh history log descriptions.
STAGING
JIRA
https://jira.mongodb.org/browse/DOCSP-48522
BUILD LOG
Self-Review Checklist
External Review Requirements
What's expected of an external reviewer?