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

typos suggestion #6

Merged
merged 3 commits into from
Jun 11, 2024
Merged

typos suggestion #6

merged 3 commits into from
Jun 11, 2024

Conversation

ccoVeille
Copy link
Contributor

  • chore: fix typos and style
  • chore: fix acronyms
  • chore: fix style

@laktak
Copy link
Owner

laktak commented Jun 11, 2024

Thank you!

When you fixed "Use a a null character" you deleted both a's.

Also why mix ```shell and ```console?

@ccoVeille
Copy link
Contributor Author

It refers to different block identifier types

Shell Session
https://github.com/github-linguist/linguist/blob/42fd3c2514375fc6ad281552368edd3fb9f6ee7f/lib/linguist/languages.yml#L6697-L6708

Shell
https://github.com/github-linguist/linguist/blob/42fd3c2514375fc6ad281552368edd3fb9f6ee7f/lib/linguist/languages.yml#L6610-L6684

You can look here

https://github.com/github-linguist/linguist/blob/42fd3c2514375fc6ad281552368edd3fb9f6ee7f/grammars.yml#L771-L773

Then here

https://github.com/github-linguist/linguist/tree/master/vendor/grammars

Then here

https://github.com/atom/language-shellscript/tree/35dc1aa1371ab75ece08fd0837330eb62e1f9da9/grammars

Then here
https://github.com/atom/language-shellscript/blob/35dc1aa1371ab75ece08fd0837330eb62e1f9da9/grammars/shell-unix-bash.cson
https://github.com/atom/language-shellscript/blob/35dc1aa1371ab75ece08fd0837330eb62e1f9da9/grammars/shell-session.cson

These are 2 distinct languages, shell session includes shell-unix

So the syntax rendering is different

```shell
# find files smaller than 10KB, in the current path
zfind 'size<10k'

# find files in the given range in /some/path
zfind 'size between 1M and 1G' /some/path
```

render this

# find files smaller than 10KB, in the current path
zfind 'size<10k'

# find files in the given range in /some/path
zfind 'size between 1M and 1G' /some/path
```console
# find files smaller than 10KB, in the current path
$ zfind 'size<10k'

# find files in the given range in /some/path
$ zfind 'size between 1M and 1G' /some/path
```
# find files smaller than 10KB, in the current path
$ zfind 'size<10k'

# find files in the given range in /some/path
$ zfind 'size between 1M and 1G' /some/path

shell is used when there is only one command, and the result of the command is not provided
console is used when there is the result of the command or multiple command, or comments, then a $ is almost always provided to distinct shell command from result

```console
$ pwd
/tmp
```
$ pwd
/tmp
```shell
$ pwd
/tmp
```
$ pwd
/tmp

acronyms are supposed to be in uppercase
@laktak laktak merged commit 0dbc2f1 into laktak:master Jun 11, 2024
1 check passed
@laktak
Copy link
Owner

laktak commented Jun 11, 2024

OK, thanks for the explanation! :)

@ccoVeille ccoVeille deleted the typos-suggestion branch June 11, 2024 17:39
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.

2 participants