Skip to content

fix: mark '|' as word #147

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

Merged
merged 3 commits into from
May 4, 2025
Merged

fix: mark '|' as word #147

merged 3 commits into from
May 4, 2025

Conversation

clason
Copy link
Member

@clason clason commented May 3, 2025

No description provided.

@clason clason force-pushed the fix-taglink branch 2 times, most recently from de54d4f to f860015 Compare May 3, 2025 10:35
@clason
Copy link
Member Author

clason commented May 3, 2025

@justinmk this removes all but two errors (one of which is trivial to fix on our side) but leaves a bunch of (~70) MISSING nodes that I can't suppress in this test (and which are often related to incorrect highlighting). What's the appetite for fixing up our docs once and for all?

(The biggest issue -- which is a huge issue -- is that Vim docs use literal backticks all over the place, which is an unresolvable conflict with codespan. Not sure how to fix that in the grammar. In the files, you can work around this by putting such input in quotes, but that will be inconsistent since all other input is not quoted.)

(Possibly ignoring all of usr_* as not our problem and not worth it?)

@justinmk
Copy link
Member

justinmk commented May 3, 2025

Vim docs use literal backticks all over the place

I haven't looked much at the usr_ docs but I haven't seen these widespread problems... our docs gen asserts zero errors

In the files, you can work around this by putting such input in quotes

for "literal backticks" that seems fine. how many cases are there of that actually

@clason
Copy link
Member Author

clason commented May 3, 2025

I haven't looked much at the usr_ docs but I haven't seen these widespread problems... our docs gen asserts zero errors

No, it only asserts zero _generateerrors; there are parsing errors that don't break docgen so are not caught in our CI. This test here is much more strict about ensuring a correct parse (even if the error may be recoverable). For example, many of theMISSING` nodes here actually tied to wrong highlighting (because the missing node is inserted in the wrong place).

for "literal backticks" that seems fine. how many cases are there of that actually

About 8 files (after my nvim PR is merged), some of those with potentially many occurrences. So it's not a minor effort (and risk of reintroducing them when we port vim patches, although current patches are unlikely to involve marks).

@clason clason force-pushed the fix-taglink branch 5 times, most recently from e804078 to 0fcd398 Compare May 3, 2025 15:46
@clason clason closed this May 3, 2025
@clason clason reopened this May 4, 2025
Copy link
Member

@justinmk justinmk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

❤️

@clason
Copy link
Member Author

clason commented May 4, 2025

Windows failure parsing the corpus is consistent; my guess is that some regex in the grammar are not Windows-safe. Since I can't deal with that and it looks unrelated to the changes here, I'm disabling the Windows job. Someone with access to Windows and tree-sitter needs to investigate, fix, and re-enable; that someone is not me, but they can ping me if they need help.

@clason clason merged commit 6dab95a into master May 4, 2025
2 checks passed
@clason clason deleted the fix-taglink branch May 4, 2025 13:17
@justinmk
Copy link
Member

justinmk commented May 4, 2025

my guess is that some regex in the grammar are not Windows-safe.

How?

@clason
Copy link
Member Author

clason commented May 4, 2025

I don't know, that's the point. But we've had issues involving that on other parsers in the past, the errors seem to revolve around * e.g. in codeblocks, and it's the only thing I can come up with that would explain the Windows-only failure.

@clason
Copy link
Member Author

clason commented May 4, 2025

Could also be an issue with the tree-sitter parse command or the action; the changes here pass nvim-treesitter CI at least.

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