Remove math mode mentions, move short hand syntax documentation #257
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sophiajt
reviewed
Mar 7, 2022
book/variables_and_subexpressions.md
Outdated
| @@ -63,3 +63,21 @@ We can do a very similar action in a single step using a subexpression path: | |||
| ``` | |||
|
|
|||
| It depends on the needs of the code and your particular style which form works best for you. | |||
|
|
|||
| ## Short-hand subexpressions | |||
There was a problem hiding this comment.
These are called "row conditions" in the engine code. Not sure if that's clearer or less clear than "short-hand subexpressions"
There was a problem hiding this comment.
Changed the header to ## Short-hand subexpressions (row conditions). Think that strikes a balance between:
- Fitting the context of the Variables and Subexpressions page
- Tying things back to the engine's terminology
sophiajt
reviewed
Mar 7, 2022
| Operators can only be used in "math mode". | ||
| One way to enter math mode is to begin an expression with `=`. | ||
| For example: | ||
| The `in` and `not-in` operators are used to test whether a value is in a list. For example: |
There was a problem hiding this comment.
just a small tweak here, the operators are in and not-in
|
Yeah, good call. I left a couple notes. Good with either "row conditions" or "short-hand subexpressions" but figured I'd give a couple options. |
|
looks good, thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What?
Remove mentions of "math mode" from the Nu Book. Move the "Short-hand math mode" section from the Math page to the Variables and Subexpressions page, rename it "Short-hand subexpressions".
Why?
When I read through the Nu Book I was confused by 2 mentions of "math mode". Here it's mentioned in a way that is not reflected in the following example, and here it's mentioned but only in the context of "short-hand math mode".
JT explained some of the historical context, and it sounds like math mode is a bit less salient to users these days:
I think we can make the docs more clear by removing the mentions of math mode altogether. The "short-hand math mode" syntax is still worth documenting, but I think the variables+subexpressions page is a better fit than the math page (because the short-hand syntax can also be used with string operators like
=~).I'm relatively new to Nu (馃) so please let me know if I've missed something important here.