Skip to content

Commit

Permalink
Merge pull request #815 from lean-ja/Seasawher/issue284
Browse files Browse the repository at this point in the history
`[inherit_doc]` を紹介する
  • Loading branch information
Seasawher authored Sep 17, 2024
2 parents 43d8464 + 635c52a commit f833c95
Show file tree
Hide file tree
Showing 2 changed files with 37 additions and 0 deletions.
36 changes: 36 additions & 0 deletions Examples/Command/Attribute/InheritDoc.lean
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
/- # inherit_doc
`inherit_doc` 属性を指定すると、既存の定数などのドキュメントコメントを使いまわすことができます。
-/
import Lean

open Lean

/-- 最初に与えた doc コメント -/
def greet := "hello"

-- `greet` のドキュメントコメントを引き継ぐ
@[inherit_doc greet] abbrev greet' := greet

section

open Elab.Command

/-- ドキュメントコメントを取得して表示するコマンド -/
elab "#doc " x:ident : command => do
let name ← liftCoreM do realizeGlobalConstNoOverload x
if let some s ← findDocString? (← getEnv) name then
logInfo m!"{s}"

end

/-- info: 最初に与えた doc コメント -/
#guard_msgs in #doc greet'

/- `inherit_doc` を使用するのは、記法を導入する際であることが多いでしょう。この場合、ドキュメントコメントの継承元を指定する必要がありません。 -/

/-- `⊔` という記号のための型クラス -/
class Sup (α : Type) where
/-- 最小上界、上限 -/
sup : α → α → α

@[inherit_doc] infixl:68 " ⊔ " => Sup.sup
1 change: 1 addition & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,7 @@
- [cases_eliminator: 独自場合分け](./Command/Attribute/CasesEliminator.md)
- [csimp: 効率的な実装に置換](./Command/Attribute/Csimp.md)
- [induction_eliminator: 独自帰納法](./Command/Attribute/InductionEliminator.md)
- [inherit_doc: ドキュメントの継承](./Command/Attribute/InheritDoc.md)
- [simps: simp補題の自動生成](./Command/Attribute/Simps.md)

- [タクティク](./Tactic/README.md)
Expand Down

0 comments on commit f833c95

Please sign in to comment.