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

Documentation misleadings #450

Closed
Bot12313 opened this issue Dec 5, 2023 · 2 comments · Fixed by #459
Closed

Documentation misleadings #450

Bot12313 opened this issue Dec 5, 2023 · 2 comments · Fixed by #459
Assignees

Comments

@Bot12313
Copy link

Bot12313 commented Dec 5, 2023

Problem

Some examples in the documentation seems either outdated, incorrect, or impossible to reproduce in online version on Peggy.

& { predicate }

The example appears to be working fine but is impossible to reproduce the results in the online version.

Even after adding the "match" label, it still produces error.

@ ( label : )? expression

Unable to use the "matches" examples noted below.

@Bot12313
Copy link
Author

Bot12313 commented Dec 5, 2023

& { predicate }

It appears that everything is now being returned as a list, so it needs to be converted back into a string to work with it.

@hildjj
Copy link
Contributor

hildjj commented Dec 5, 2023

The posPredicate one should read:

posPredicate = @match:$[0-9]+ &{return parseInt(match, 10) < 100}

note the $. This returns "23" but fails on "233". The @ is so that the predicate doesn't return a confusing null.

The second one needs a better default input of "aaa bbbb" or something.

Valid issue, willfix.

@hildjj hildjj self-assigned this Dec 5, 2023
hildjj added a commit to hildjj/peggy that referenced this issue Jan 27, 2024
@hildjj hildjj mentioned this issue Jan 27, 2024
hildjj added a commit to hildjj/peggy that referenced this issue Feb 13, 2024
* main: (107 commits)
  Version update.  Check npmignore.  Audit CHANGELOG.md.
  4.0.0
  Update dependencies final time before release.
  Fix indentation in one part of examples/javascript.pegjs.  Fixes peggyjs#445.
  Code review issues
  Add developer docs.  Fixes peggyjs#466.
  Add directories when they don't exist, rather than throwing an error.  Fixes peggyjs#440.
  Update changelog.  Include peggyjs#463 as well.
  Fix peggyjs#379.  Move reportInfiniteRecursion to prepare phase, ensure that it doesn't keep going when it finds an error.
  Typo: 'rutimes'
  Mark IE as explicitly unsupported
  Switch to flat eslint config.  Lint minified output for web compat.
  Code review nits
  Add tests, fix up fromMem to not need gross hack.
  Adds support for running tests against es module output.  Fixes peggyjs#399.
  Slight wording tweak.  Double-checked that peggyjs#415 is fixed.
  Fixes peggyjs#434
  Update bundles as well
  Fixes peggyjs#450
  Update dependencies, including new lint rules.  Move to simpler tsconfig so that eslint can easily find the correct file.  Fix small lint issues with new rules.
  ...
hildjj added a commit that referenced this issue Feb 13, 2024
* main: (107 commits)
  Version update.  Check npmignore.  Audit CHANGELOG.md.
  4.0.0
  Update dependencies final time before release.
  Fix indentation in one part of examples/javascript.pegjs.  Fixes #445.
  Code review issues
  Add developer docs.  Fixes #466.
  Add directories when they don't exist, rather than throwing an error.  Fixes #440.
  Update changelog.  Include #463 as well.
  Fix #379.  Move reportInfiniteRecursion to prepare phase, ensure that it doesn't keep going when it finds an error.
  Typo: 'rutimes'
  Mark IE as explicitly unsupported
  Switch to flat eslint config.  Lint minified output for web compat.
  Code review nits
  Add tests, fix up fromMem to not need gross hack.
  Adds support for running tests against es module output.  Fixes #399.
  Slight wording tweak.  Double-checked that #415 is fixed.
  Fixes #434
  Update bundles as well
  Fixes #450
  Update dependencies, including new lint rules.  Move to simpler tsconfig so that eslint can easily find the correct file.  Fix small lint issues with new rules.
  ...
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 a pull request may close this issue.

2 participants