|
1 | 1 | # Commands |
2 | 2 |
|
3 | | -Mathlib version: `790901a8c97c730ae7af9bd44fe60c733a21d9ba` |
| 3 | +Mathlib version: `d0cc8265b663c197e6500917efd4383278cf073e` |
4 | 4 |
|
5 | 5 | ## \#adaptation_note |
6 | 6 | Defined in: `adaptationNoteCmd` |
@@ -1992,31 +1992,44 @@ a theorem `foo_def : foo = 42`. |
1992 | 1992 | ## library_note |
1993 | 1993 | Defined in: `Batteries.Util.LibraryNote.commandLibrary_note___` |
1994 | 1994 |
|
1995 | | -``` |
1996 | | -library_note "some tag" /-- |
1997 | | -... some explanation ... |
1998 | | --/ |
1999 | | -``` |
2000 | | -creates a new "library note", which can then be cross-referenced using |
| 1995 | +`library_note «my note» /-- documentation -/` creates a library note named `my note` |
| 1996 | +in the `LibraryNote` namespace, whose content is `/-- documentation -/`. |
| 1997 | +This can then be cross-referenced using |
2001 | 1998 | ``` |
2002 | 1999 | -- See note [some tag] |
2003 | 2000 | ``` |
2004 | 2001 | in doc-comments. |
| 2002 | +You can access the contents using, for example, `#print LibraryNote.«my note»`. |
2005 | 2003 | Use `#help note "some tag"` to display all notes with the tag `"some tag"` in the infoview. |
2006 | 2004 | This command can be imported from Batteries.Tactic.HelpCmd . |
2007 | 2005 |
|
| 2006 | +## library_note |
| 2007 | +Defined in: `Batteries.Util.LibraryNote.commandLibrary_note____1` |
| 2008 | + |
| 2009 | +Support the old `library_note "foo"` syntax, with a deprecation warning. |
| 2010 | + |
2008 | 2011 | ## library_note2 |
2009 | 2012 | Defined in: `commandLibrary_note2____1` |
2010 | 2013 |
|
2011 | 2014 | Support the old `library_note "foo"` syntax, with a deprecation warning. |
2012 | 2015 |
|
| 2016 | +## library_note2 |
| 2017 | +Defined in: `Batteries.Util.LibraryNote.commandLibrary_note2___` |
| 2018 | + |
| 2019 | +Support the old `library_note2 «foo»` syntax, with a deprecation warning. |
| 2020 | + |
2013 | 2021 | ## library_note2 |
2014 | 2022 | Defined in: `commandLibrary_note2___` |
2015 | 2023 |
|
2016 | 2024 | `library_note2 «my note» /-- documentation -/` creates a library note named `my note` |
2017 | 2025 | in the `Mathlib.LibraryNote` namespace, whose content is `/-- documentation -/`. |
2018 | 2026 | You can access this note using, for example, `#print Mathlib.LibraryNote.«my note»`. |
2019 | 2027 |
|
| 2028 | +## library_note2 |
| 2029 | +Defined in: `Batteries.Util.LibraryNote.commandLibrary_note2____1` |
| 2030 | + |
| 2031 | +Support the old `library_note2 "foo"` syntax, with a deprecation warning. |
| 2032 | + |
2020 | 2033 | ## lrat_proof |
2021 | 2034 | Defined in: `Mathlib.Tactic.Sat.commandLrat_proof_Example____` |
2022 | 2035 |
|
|
0 commit comments