Skip to content

Commit 2e1d956

Browse files
committedMar 20, 2025·
Don't put "-* no-capture-flag *-" on its own line
Otherwise, the documentation will be garbled
1 parent e3edfa5 commit 2e1d956

File tree

4 files changed

+7
-10
lines changed

4 files changed

+7
-10
lines changed
 

‎M2/Macaulay2/packages/Macaulay2Doc/functions/debug-doc.m2

+1-2
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,7 @@ Node
2727
Text
2828
This function allows access to the local symbols of a any loaded file.
2929
Example
30-
-* no-capture-flag *-
31-
load "Macaulay2Doc/demos/demo1.m2"
30+
load "Macaulay2Doc/demos/demo1.m2" -* no-capture-flag *-
3231
listUserSymbols
3332
debug "Macaulay2Doc/demos/demo1.m2"
3433
listUserSymbols

‎M2/Macaulay2/packages/Macaulay2Doc/functions/examples-doc.m2

+2-1
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,8 @@ Node
4646
Text
4747
Certain examples or tests might not be compatible with @TT "capture"@. In such cases,
4848
use the string @CODE "-* no-capture-flag *-"@ somewhere within @TT "str"@ so that the
49-
code is run in a separate Macaulay2 subprocess instead.
49+
code is run in a separate Macaulay2 subprocess instead. In examples, this string
50+
should not go on its own line or the documentation will be garbled.
5051
SeeAlso
5152
check
5253
examples

‎M2/Macaulay2/packages/Macaulay2Doc/functions/findProgram-doc.m2

+2-3
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,10 @@ doc ///
137137
file, then @TT "name"@ should coincide with the name of this
138138
file.
139139
Example
140-
-* no-capture-flag *-
141-
programPaths#"gfan" = "/path/to/gfan/"
140+
programPaths#"gfan" = "/path/to/gfan/" -* no-capture-flag *-
142141
gfan = findProgram("gfan", "gfan _version --help", Verbose => true)
143142
Text
144-
If @TT "cmd"@ is not provided, then @TT "cmd"@ is run with the common
143+
If @TT "cmd"@ is not provided, then @TT "name"@ is run with the common
145144
@TT "--version"@ command line option.
146145
Example
147146
findProgram "normaliz"

‎M2/Macaulay2/packages/Macaulay2Doc/operators/assignment.m2

+2-4
Original file line numberDiff line numberDiff line change
@@ -242,8 +242,7 @@ document {
242242
}},
243243
"The first line of the following example illustrates the syntax above.",
244244
EXAMPLE lines ///
245-
-* no-capture-flag *-
246-
String * String = peek;
245+
String * String = peek; -* no-capture-flag *-
247246
"left" * "right" = "value"
248247
///,
249248
PARA "Warning: the installation of new methods may supplant old ones, changing the behavior of Macaulay2."
@@ -517,8 +516,7 @@ document {
517516
}},
518517
"The first line of the following example illustrates the syntax above.",
519518
EXAMPLE lines ///
520-
-* no-capture-flag *-
521-
String * String := peek;
519+
String * String := peek; -* no-capture-flag *-
522520
"left" * "right"
523521
///,
524522
PARA "Warning: the installation of new methods may supplant old ones, changing the behavior of Macaulay2."

0 commit comments

Comments
 (0)