docs(essence-parser/lsp): adding documentation for error detection and lsp#1832
Open
Soph1514 wants to merge 35 commits into
Open
docs(essence-parser/lsp): adding documentation for error detection and lsp#1832Soph1514 wants to merge 35 commits into
Soph1514 wants to merge 35 commits into
Conversation
|
Automatically assigned this pull request to @Soph1514. If it makes more sense for someone else to own it, feel free to reassign it. |
Soph1514
marked this pull request as draft
May 22, 2026 17:03
Book PreviewPreview: https://conjure-cp.github.io/conjure-oxide-reports/pr/1832/book/ |
…ection' into docs/error-detection
Contributor
|
@Soph1514 why is that one check failing? do you know what it is? |
Contributor
Author
|
I rerun the test, it is fine now. Not sure what it was |
a-nosnitram
force-pushed
the
docs/error-detection
branch
from
May 24, 2026 15:54
1ad5469 to
13a5d6b
Compare
Soph1514
requested review from
chococara-exe,
Copilot and
leiamcalisteryoung
and removed request for
Copilot and
leiamcalisteryoung
May 25, 2026 10:59
…conjure-oxide into docs/error-detection
…t in error-detection.md
EEJDempster
approved these changes
May 25, 2026
EEJDempster
left a comment
Contributor
There was a problem hiding this comment.
looks good to me! thanks for updating the server docs :) lgtm
Soph1514
marked this pull request as ready for review
May 28, 2026 10:42
HKhan-5
reviewed
Jun 3, 2026
|
|
||
| These are detected during parser traversal/conversion while building model structures. | ||
|
|
||
| # Detection Flow (parse_model.rs) |
Contributor
There was a problem hiding this comment.
It would be nice if this was a link to parse_model.rs
| The [roundtrip/invalid/semantic test directory](https://github.com/conjure-cp/conjure-oxide/tree/main/tests-integration/tests/roundtrip/invalid/semantic) contains various semantic error cases and their expected outputs. | ||
|
|
||
| ## Note: Keywords as Identifiers | ||
| The parser's reserved/keyword list is maintained in `crates/conjure-cp-essence-parser/src/parser/keyword_checks.rs`. When new language keywords are added, update that file so the parser and documentation remain consistent. |
Contributor
There was a problem hiding this comment.
Would be nice if this was a link too
| @@ -1,12 +1,140 @@ | |||
| [//]: # (Author: Anastasia Martinson) | |||
| [//]: # (Last Updated: 18/12/2025) | |||
| [//]: # (Author: Liz Dempster, Anastasia Martinson) | |||
Contributor
There was a problem hiding this comment.
This file is a great overview that should be the first one that is seen. I suggest changing its position to the top of its section
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
6 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR adds documentation for the error detection implemented in the parser this year. It adds a new directory in the parser documentation folder which contains 3 files (error detection, syntactic, and semantic errors). Some information was already documented in the lsp docs so it was moved to the new directory. The lsp docs were updated to describe only how the lsp uses the error detection of the parser and reference the error detection docs for more information. The diagnostics api doc was also updated in the lsp folder.
This wasn't split into multiple PRs to avoid merge conflicts since the folder structure was also updated.