Skip to content

Add doc for optional arguments always/never used#72

Merged
fantazio merged 8 commits intoLexiFi:masterfrom
fantazio:doc_opt_args
Apr 13, 2026
Merged

Add doc for optional arguments always/never used#72
fantazio merged 8 commits intoLexiFi:masterfrom
fantazio:doc_opt_args

Conversation

@fantazio
Copy link
Copy Markdown
Collaborator

@fantazio fantazio commented Apr 9, 2026

Fix #61

The new documentation provides some preliminary definitions to understand what the analyzer tracks and may report in the optional arguments always/never used sections.
It also provides examples focusing on different simple code constructs (partial application, higher-order-function, ...), and document known limitations.

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

Comment thread docs/optional_arguments/code_constructs/EXTERNAL_APPLICATION.md Outdated
Comment thread docs/optional_arguments/code_constructs/EXTERNAL_APPLICATION.md Outdated
Comment thread docs/optional_arguments/code_constructs/HIGHER_ORDER_FUNCTION.md Outdated
Comment thread docs/optional_arguments/code_constructs/HIGHER_ORDER_FUNCTION.md Outdated
Comment thread docs/optional_arguments/code_constructs/HIGHER_ORDER_FUNCTION.md Outdated
Comment thread docs/optional_arguments/OPTIONAL_ARGUMENTS.md
Comment thread docs/optional_arguments/OPTIONAL_ARGUMENTS.md Outdated
Comment thread docs/optional_arguments/OPTIONAL_ARGUMENTS.md
Comment thread docs/optional_arguments/OPTIONAL_ARGUMENTS.md Outdated
Comment thread docs/optional_arguments/OPTIONAL_ARGUMENTS.md Outdated
Provide definitions, related compiler warnings, basic usage and a
limitation.
Demonstrates a simple case of always and never used optional arguments
and their resolution.
Demonstrates a simple case of always and never used optional arguments
and their resolution.
Demonstrates a simple case of always and never used optional arguments
and their resolution.
Demonstrates a simple case of always and never used optional arguments
and their resolution.
Demonstrates a simple case of always and never used optional arguments
and their resolution.
Demonstrates a simple case of always used optional arguments
and their resolution.
Apply suggestions from code review

Co-authored-by: Corentin De Souza <fantazio@users.noreply.github.com>
@fantazio fantazio merged commit 1f5109c 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 optional arguments always/never used sections

1 participant