Skip to content

Fix docs's expected results and document limitations #65

Merged
fantazio merged 8 commits intoLexiFi:masterfrom
fantazio:fix_docs_exp
Mar 23, 2026
Merged

Fix docs's expected results and document limitations #65
fantazio merged 8 commits intoLexiFi:masterfrom
fantazio:fix_docs_exp

Conversation

@fantazio
Copy link
Copy Markdown
Collaborator

The expected results for the functor and modtyp examples were wrong for the threshold-* scenarios.
They are are fixed and their uncovered invalid results are fixed too. On the way, the PR also fixes #57.

The documentation is updated to explicit list known limitations :

Listed limitations have their code examples included in the testsuite, like the other examples in the docs.

Some values were wrongly expected to be reported as used twice :
- Those in `functor_lib.mli` (`External_param.*`) are actually only used
  once.
- Those in `modtyp_lib.mli` (`M_subst.*`) should not be reported at all
  because they belong to module type `T`.
This fixes the duplicated reports in case a module is included within
its compilation unit
(LexiFi#57).
This replaces the previous fix for internal includes. It also fixes the
invalid tracking and reporting of values coming from module types with
substition.
…p unit

This fixes the potential duplicate use for values in modules used as
functor parameters outside their compilation units.
Reflect the recent fix on the example
Document the module type limitation and issue LexiFi#64

As for the examples, code presented in the limitations is added to the
testsuite.
A significant part of a previous code review's suggestion was left out
when applying the suggestion.
@fantazio fantazio merged commit ca02c3d into LexiFi:master Mar 23, 2026
5 checks passed
@fantazio fantazio deleted the fix_docs_exp branch March 23, 2026 10:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Duplicated reports on values coming from an include

1 participant