Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/generate_indices.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,8 @@ def generate_rst_file(error: QueryErrorCode) -> None:
"",
f"**Message**: ``{error.message}``",
"",
f"**Documentation / interface conformance**: ``{error.docs_interface_flag}``",
"",
error.docs.strip()
if error.docs.strip()
else "**Description**: " + error.message,
Expand Down
4 changes: 4 additions & 0 deletions docs/source/dev_docs/linter_development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Each linter must override the `validate_tokens()` method and the `validate_query
Best practices
--------------
- **Use standardized linter messages** defined in `constants.QueryErrorCode`.
Each message tuple includes a documentation/interface conformance flag:
``DOCS_INTERFACE_OK`` when implementation behavior conforms to documented rules, and
``DOCS_INTERFACE_MISMATCH`` when diagnostics enforce a documented rule that does not
fully match observed database behavior.
- **Add details** in messages for guidance (e.g., invalid format, missing logic).
- Ensure **valid token sequences** using the `VALID_TOKEN_SEQUENCES` dictionary.
- Consider using **utility methods** provided by `linter_base.py`:
Expand Down
Loading
Loading