Skip to content

feat: improve doc-strings for differential geometry elaborators #39677

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

Open
grunweg wants to merge 2 commits into
base: master
Choose a base branch
from
+463 −1
Open

feat: improve doc-strings for differential geometry elaborators #39677

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c2c410
doesn't work yet because of Lean core bug
grunweg May 21, 2026
c3f2e7b
Non-module version kind of works!
grunweg May 21, 2026
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: 16 additions & 1 deletion Mathlib/Geometry/Manifold/MFDeriv/NormedSpace.lean
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,8 +418,23 @@ open scoped Bundle Manifold ContDiff

open Lean Meta Elab Tactic

open Doc
@[doc_command] def foobar (n : Ident) : DocM <| Block ElabInline ElabBlock := do
let doc ← realizeGlobalConstNoOverloadWithInfo n
let some docStr ← findDocString? (← getEnv) doc
| throwError "No doc-string for `{.ofConstName doc}`"
-- Future: once there is a better auto-converter between markdown and verso doc-strings,
-- rewrite this code accordingly!
-- Perhaps, it could be nice to write .verso here.
return .para #[.text docStr]

set_option doc.verso true in
set_option doc.verso.suggestions false in
/-- `d% f x` (scoped to the `Manifold` namespace) elaborates to `mvfderiv I J f x`,
trying to determine `I` and `J` from the local context. -/
trying to determine `I` and `J` from the local context.

{foobar} -/
-- goal: now insert the doc-string of mvfderiv
scoped elab:max "d%" ppSpace t:term:arg : term => do
let e ← ensureIsFunction <| ← Term.elabTerm t none
let (srcI, _tgtI) ← findModels e none
Expand Down
Loading
Loading