PhyslibSearch

Physlib.Meta.Remark.Basic

3 declarations

opaque

Persistent Environment Extension for Remarks

#remarkExtension

The `Physlib.remarkExtension` is a persistent environment extension used to store information associated with the `remark` command. It maintains data as an `Array` of `RemarkInfo` objects, allowing these remarks to be recorded and persisted throughout the Lean environment.

definition

Syntax of the `remark` command: `remark <ident> := <str>`

#remark_syntax

The `remark_syntax` defines the structure of a command used for recording important information within the environment. The command follows the syntax `remark <ident> := "<string>"`, where `<ident>` is a unique identifier and `"<string>"` is a string literal containing the documentation or remark.

definition

Elaborator for the `remark` command

#elabRemark

The `Physlib.elabRemark` function is a command elaborator designed to process the syntax `remark n:=n := s`. It extracts the string content ss, the identifier nn, and metadata including the module name, current namespace, and the line number where the command appears in the source file. This information is bundled into a `RemarkInfo` structure and stored within the persistent environment extension `remarkExtension`.