You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I think it'd be much more readable if the explanations weren't > quotes and if they came before the code they explain. I've gotten confused many times when reading it, thinking one explanation belongs to another piece of code.
Also I think many other parts of the book also show the explanation before the example and I think this change would go in line with that.
The text was updated successfully, but these errors were encountered:
We appreciate PRs that make nushell easier to understand. However, the hard part comes in when people have different definition of what intuitive is. It's hard to write software that everyone likes and it's hard to write documentation that everyone understands. Please feel free to change anything you like and we'll look at the PR. Being more clear and intuitive is helpful.
After messing around with the page for a while I realized almost every explanation is written in such a way that the code has to come before (and it isn't as easy as just changing verb tenses). I don't feel like making the PR myself because I feel like I would end up completely rewriting every explanation in the cheat sheet.
I'm leaving the issue open in case anyone else wants to do it.
I could open a PR making this change.
I think it'd be much more readable if the explanations weren't
> quotes
and if they came before the code they explain. I've gotten confused many times when reading it, thinking one explanation belongs to another piece of code.Also I think many other parts of the book also show the explanation before the example and I think this change would go in line with that.
The text was updated successfully, but these errors were encountered: