opaque Lean.docStringExt : MapDeclarationExtension String

def Lean.addBuiltinDocString (declName : Name) (docString : String) : IO Unit

Adds a builtin docstring to the compiler.

Links to the Lean manual aren't validated.

Equations

• Lean.addBuiltinDocString declName docString = ST.Ref.modify Lean.builtinDocStrings✝ fun (x : Lean.NameMap String) => x.insert declName docString.removeLeadingSpaces

def Lean.addDocStringCore {m : Type → Type} [Monad m] [MonadError m] [MonadEnv m] (declName : Name) (docString : String) : m Unit

Equations

• One or more equations did not get rendered due to their size.

def Lean.addDocStringCore' {m : Type → Type} [Monad m] [MonadError m] [MonadEnv m] (declName : Name) (docString? : Option String) : m Unit

Equations

• Lean.addDocStringCore' declName (some docString) = Lean.addDocStringCore declName docString
• Lean.addDocStringCore' declName none = pure ()

def Lean.findSimpleDocString? (env : Environment) (declName : Name) (includeBuiltin : Bool := true) : IO (Option String)

Finds a docstring without performing any alias resolution or enrichment with extra metadata.

Docstrings to be shown to a user should be looked up with Lean.findDocString? instead.

Equations

• One or more equations did not get rendered due to their size.

structure Lean.ModuleDoc : Type

• doc : String
• declarationRange : DeclarationRange

def Lean.addMainModuleDoc (env : Environment) (doc : ModuleDoc) : Environment

Equations

• Lean.addMainModuleDoc env doc = Lean.PersistentEnvExtension.addEntry Lean.moduleDocExt✝ env doc

def Lean.getMainModuleDoc (env : Environment) : PersistentArray ModuleDoc

Equations

• Lean.getMainModuleDoc env = Lean.moduleDocExt✝.getState env

def Lean.getModuleDoc? (env : Environment) (moduleName : Name) : Option (Array ModuleDoc)

Equations

• Lean.getModuleDoc? env moduleName = Option.map (fun (modIdx : Lean.ModuleIdx) => Lean.PersistentEnvExtension.getModuleEntries Lean.moduleDocExt✝ env modIdx) (env.getModuleIdx? moduleName)

def Lean.getDocStringText {m : Type → Type} [Monad m] [MonadError m] (stx : TSyntax `Lean.Parser.Command.docComment) : m String

Equations

• One or more equations did not get rendered due to their size.