leanprover-community / leanprover-community/lean

expose `#help options` to meta-Lean

Open
#385 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
434
Forks
79
PR merge metrics
No merged PRs in 30d

Description

At https://leanprover.zulipchat.com/#narrow/stream/113488-general/topic/Dots.20in.20outputs.20.2B.20documentation it was pointed out that we have no manual page listing all the configuration options.

These options are at least slightly dynamic, in that users can create new trace options, so such a page would need to be generated from compiled mathlib the same way as the rest of the docs.

Is it possible to expose the output of #help options? Unfortunately the descriptions for all of the trace options are the same; we'll have to do something there too. As a first pass we could just collect them all together under one description.

Prerequisites
  • Put an X between the brackets on this line if you have done all of the following:
    • Checked that your issue isn't already filed.
    • Reduced the issue to a self-contained, reproducible test case.
Description

[Description of the issue]

Steps to Reproduce
  1. [First Step]
  2. [Second Step]
  3. [and so on...]

Expected behavior: [What you expect to happen]

Actual behavior: [What actually happens]

Reproduces how often: [What percentage of the time does it reproduce?]

Versions

You can get this information from copy and pasting the output of lean --version,
please include the OS and what version of the OS you're running.

Additional Information

Any additional information, configuration or data that might be necessary to reproduce the issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the implementation of #help options and the documentation generation path used with compiled mathlib. Determine how the command's output can be exposed to the generated docs, including how trace options are grouped when their descriptions are identical. Done means the generated documentation contains the available configuration options and reflects dynamically registered options.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.