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

Fixed documentation typo #494

Merged
merged 3 commits into from
Feb 26, 2024
Merged

Fixed documentation typo #494

merged 3 commits into from
Feb 26, 2024

Conversation

XenoS-ITA
Copy link
Contributor

in the Importing External Rules section, where the --allowed-start-rules option was being remembered there was \* and not *

in the `Importing External Rules` section, where the `--allowed-start-rules` option was being remembered the was the command \* and not * as it should
@hildjj
Copy link
Contributor

hildjj commented Feb 25, 2024

In many shells, if you don't escape that '*', it's going to glob-expand to all of the files in cwd.

@hildjj
Copy link
Contributor

hildjj commented Feb 25, 2024

I'd settle for '*' as a compromise that should work most places?

@hildjj
Copy link
Contributor

hildjj commented Feb 25, 2024

Also, please add yourself to the AUTHORS file and add an entry in CHANGELOG.md

@XenoS-ITA
Copy link
Contributor Author

ok, so probably only a windows thing (the fact that it will not escape it)

when executing npx peggy file.peggy --allowed-start-rules \* on CMD it will prompt with:

Error parsing grammar
Unknown start rule "\*"

@XenoS-ITA
Copy link
Contributor Author

XenoS-ITA commented Feb 25, 2024

I'd settle for '*' as a compromise that should work most places?

that doesn't work either on windows.
probably the best is to put both versions or --allowed-start-rules * (remember the to escape it on some shells)

@hildjj
Copy link
Contributor

hildjj commented Feb 25, 2024

what happens with single quotes on windows? windows' shell makes very strange decisions because it leaves globbing to each program to do.

@XenoS-ITA
Copy link
Contributor Author

what happens with single quotes on windows? windows' shell makes very strange decisions because it leaves globbing to each program to do.

same:
Error parsing grammar
Unknown start rule "'*'"

@XenoS-ITA
Copy link
Contributor Author

What should i write in the changelog?

@hildjj
Copy link
Contributor

hildjj commented Feb 25, 2024

do double quotes work?

In the changelog, put a link to this PR, and describe the change briefly. something like "updated docs to make `--allowedRules *` more clear

@hildjj hildjj merged commit 9955b45 into peggyjs:main Feb 26, 2024
9 checks passed
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