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

Bugs in book #418

Open
1 of 3 tasks
jeertmans opened this issue Sep 11, 2024 · 3 comments
Open
1 of 3 tasks

Bugs in book #418

jeertmans opened this issue Sep 11, 2024 · 3 comments
Labels
book Related to the book good first issue Good for newcomers

Comments

@jeertmans
Copy link
Collaborator

jeertmans commented Sep 11, 2024

Here is a short list of bugs / improvements for the book

Please feel free to open a PR if you want to fix those issues!

@jeertmans jeertmans added good first issue Good for newcomers book Related to the book labels Sep 11, 2024
@jeertmans jeertmans pinned this issue Sep 12, 2024
@fmorroni
Copy link

fmorroni commented Dec 1, 2024

Hi I'd like to handle these improvements to the documentation. I can add the section regarding subpatterns, and I'd also like to add a section for contexts/morphing which I don't think is mentioned at all in the book.

broken link to regex in https://logos.maciej.codes/attributes/logos.html;

I think this has already been fixed, at the very leas the link isn't broken, do you think it should point somewhere else?

This should also be fixed in the docs.

@fmorroni
Copy link

fmorroni commented Dec 1, 2024

Also, regarding the debugging section, I think it should be mentioned how the initial state is chosen from the generated DFA.
In the given example, when explaining how to match the "fast" token, it's mentioned that the search begins by looking at state 9, but we could just as well have started from state 4 which wouldn't have matched with the proper token.
From my testing I believe the initial state is always the one with the largest value (9 in this case), but I'm not sure if this is really the case or just a coincidence.

@jeertmans
Copy link
Collaborator Author

Hi @fmorroni, I'd be more than happy to accept any PR that improves the docs :-)

broken link to regex in https://logos.maciej.codes/attributes/logos.html;

I think this has already been fixed, at the very leas the link isn't broken, do you think it should point somewhere else?

Indeed, this was fixed in 0f361d6.

Also, regarding the debugging section, I think it should be mentioned how the initial state is chosen from the generated DFA.

Yes! The debugging section is still incomplete, and any addition to it is very welcome!

About the initial state theory, this makes sense, but I didn't proof-check this (I didn't write this part of the code), so it might be safe to verify this by checking relevant source code.

Feel free to create a first PR, and we will see if anything needs to be changed / added.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
book Related to the book good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants