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

Explanations in the cheat sheet should come before the code that's explained #1262

Open
SeerLite opened this issue Feb 26, 2024 · 2 comments

Comments

@SeerLite
Copy link
Contributor

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.

@fdncred
Copy link
Collaborator

fdncred commented Feb 26, 2024

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.

@SeerLite
Copy link
Contributor Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants