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

Update cheat_sheet.md #1425

Merged
merged 1 commit into from
May 29, 2024
Merged

Update cheat_sheet.md #1425

merged 1 commit into from
May 29, 2024

Conversation

Kissaki
Copy link
Contributor

@Kissaki Kissaki commented May 29, 2024

Fixes #1262

This change fixes a few issues the cheat sheet had, and makes some additional improvements:

  • Drop non-printable characters
  • Use description text instead of formatting them as quotes
  • Description before code (block/case titles/headlines) (like suggested in Explanations in the cheat sheet should come before the code that's explained #1262, which I agree with)
  • Use imperative mood (for the most part)
  • Some wording improvements
  • Some conciseness improvements (a cheat sheet should be concise, specific, and generalized at the same time)
  • Consistently use > for commands and add missing returns (some code lines were missing, mixed, or wrong)

Fixes nushell#1262

This change fixes a few issues the cheat sheet had, and makes some additional improvements:

* Drop non-printable characters
* Use description text instead of formatting them as quotes
* Description before code (block/case titles/headlines) (like suggested in nushell#1262, which I agree with)
* Use imperative mood (for the most part)
* Some wording improvements
* Some conciseness improvements (a cheat sheet should be concise, specific, and generalized at the same time)
* Consistently use `>` for commands and add missing returns (some code lines were missing, mixed, or wrong)
@fdncred
Copy link
Collaborator

fdncred commented May 29, 2024

ok, thanks.

@fdncred fdncred merged commit 026e0f5 into nushell:main May 29, 2024
2 checks passed
@fdncred
Copy link
Collaborator

fdncred commented May 29, 2024

Now that I look at the rendering, the top part doesn't look as good without the nushell syntax highlighting.
image

same here
image

@Kissaki
Copy link
Contributor Author

Kissaki commented May 30, 2024

I guess I'll change those back to code blocks then

@Kissaki
Copy link
Contributor Author

Kissaki commented May 30, 2024

I agree it looks better with syntax highlighting

Kissaki added a commit to Kissaki/nushell.github.io that referenced this pull request May 30, 2024
for syntax highlighting

as discussed in PR nushell#1425
fdncred pushed a commit that referenced this pull request May 30, 2024
for syntax highlighting

as discussed in PR #1425
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

Successfully merging this pull request may close these issues.

Explanations in the cheat sheet should come before the code that's explained
2 participants