Skip to content

Refine description of "About" and mention transparency. #19716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
coqbot-app merged 1 commit into from
Nov 4, 2024
Merged

Refine description of "About" and mention transparency. #19716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 11 additions & 6 deletions doc/sphinx/proof-engine/vernacular-commands.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,13 +70,18 @@ described elsewhere

.. cmd:: About @reference {? @univ_name_list }

Displays information about the :n:`@reference` object, which,
if a proof is open, may be a hypothesis of the selected goal,
or an accessible theorem, axiom, etc.:
its kind (module, constant, assumption, inductive,
constructor, abbreviation, …), long name, type, implicit arguments and
Displays information about the :n:`@reference` object, which may be the
name of any accessible defined symbol, such as a theorem, constructor,
fixpoint or module. If a proof is open, :n:`@reference` may refer to a
hypothesis of the selected goal. The information includes:
the kind of the object (module, constant, assumption, inductive,
constructor, abbreviation, projection, coercion, …), long name, type,
opacity/transparency, implicit arguments, argument names and
argument scopes (as set in the definition of :token:`reference` or
subsequently with the :cmd:`Arguments` command). It does not print the body of definitions or proofs.
subsequently with the :cmd:`Arguments` command). It does not print the
body of definitions or proofs.

See :cmd:`Strategy` for details on opacity.

.. cmd:: Check @term

Expand Down
2 changes: 2 additions & 0 deletions doc/sphinx/proofs/writing-proofs/equality.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -996,6 +996,8 @@ which supports additional fine-tuning.
constants always remain transparent. This mechanism is only intended for
debugging purposes.

Use the :cmd:`About` command to see if a symbol is transparent or opaque.

.. cmd:: Transparent {? ! } {+ @reference }

The opposite of :cmd:`Opaque`, it marks the specified constants
Expand Down
6 changes: 3 additions & 3 deletions vernac/prettyp.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -174,13 +174,13 @@ let print_opacity env ref =
match s with
| FullyOpaque -> str "opaque"
| TransparentMaybeOpacified Conv_oracle.Opaque ->
str "basically transparent but considered opaque for reduction"
str "opaque but may be made transparent"
| TransparentMaybeOpacified lev when Conv_oracle.is_transparent lev ->
str "transparent"
| TransparentMaybeOpacified (Conv_oracle.Level n) ->
str "transparent (with expansion weight " ++ int n ++ str ")"
str "transparent (level " ++ int n ++ str ")"
| TransparentMaybeOpacified Conv_oracle.Expand ->
str "transparent (with minimal expansion weight)"]
str "transparent (expand)"]

(** Printing coercion status *)

Expand Down