Skip to content

Add doc for coding style#73

Merged
fantazio merged 7 commits intoLexiFi:masterfrom
fantazio:doc_style
Apr 13, 2026
Merged

Add doc for coding style#73
fantazio merged 7 commits intoLexiFi:masterfrom
fantazio:doc_style

Conversation

@fantazio
Copy link
Copy Markdown
Collaborator

Fix #62

The new documentation provides some preliminary definitions to understand what the analyzer tracks and may report in the coding style section.
It also provides examples for each coding style issue category, and document known limitations.

The code of the examples explored is also provided in its own files to ease user experimentation, and is included in the testsuite.

This PR includes a small fix of the unit reports.

Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
Comment thread docs/coding_style/CODING_STYLE.md Outdated
fantazio and others added 7 commits April 13, 2026 16:09
Provide a short description and usage.
Provide a short description of its usage, an example and its limitation.
Provide a short description of its usage, an example and its limitation.
Provide a short description of its usage and an example
Provide a short description of its usage, an example and limitation.
Issue reports on unit binding may be duplicated with `other` in case the
`Tpat_value` subpattern is not a `Tpat_construct`. This adds the other
understood patterns to the list of "silenced" patterns in `Tpat_value`.

This also updates the reported "unknown" unit patterns as `!!patern!!`.

The FP introduced in the previous example are now fixed.
The docs is fixed accordingly.
Apply suggestions from code review

Co-authored-by: Corentin De Souza <fantazio@users.noreply.github.com>
@fantazio fantazio merged commit bb8359e into LexiFi:master Apr 13, 2026
5 checks passed
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.

Document the coding style section

1 participant