leanprover / leanprover/reference-manual

Document the effect of `@[expose]`/`@[no_expose]` on each declaration

Open
#771 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

doc-request
Dominant language
Lean
Stars
129
Forks
67
Avg merge
1d 15h
Merged PRs (30d)
16

Description

What question should the reference manual answer?

There are two separate but related issues with https://lean-lang.org/doc/reference/latest/Source-Files-and-Modules/#module-scopes currently:

  1. @[no_expose] isn't documented
  2. @[expose] is only documented in relation to def, leaving implicit what @[expose]/@[no_expose] do to an abbrev. instance, structure, class, in particular what the default exposition is for each of these.

Additional context

Zulip

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 with the Source Files and Modules → module scopes section of the reference manual, then investigate how @[expose] and @[no_expose] apply to def, abbrev, instance, structure, and class declarations. Done means the manual documents @[no_expose] and states the exposition effect and default for each listed declaration.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
52/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.