Skip to content

Commit

Permalink
doc update for insert, switch, replace, RingMap acting on lists
Browse files Browse the repository at this point in the history
  • Loading branch information
pzinn committed Sep 29, 2024
1 parent 842ff57 commit 56f37a0
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion M2/Macaulay2/packages/Macaulay2Doc/doc3.m2
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ document {
(symbol \,Function,VirtualTally),
(symbol \,SelfInitializingType,VisibleList),
(symbol \,Command,VisibleList),
(symbol \,RingMap,List),
(symbol \,RingMap,VisibleList),
(symbol \,Command,VirtualTally),
(symbol /,VisibleList,SelfInitializingType),
(symbol /,List,Command),
Expand Down
6 changes: 3 additions & 3 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/insert-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
doc///
Key
insert
(insert,ZZ,Thing,VisibleList)
(insert,ZZ,Thing,BasicList)
Headline
copy a list, inserting an element
Usage
insert(i, x, L)
Inputs
i: ZZ
x: Thing
L: VisibleList
L: BasicList
Outputs
L2: VisibleList
L2: BasicList
a copy of {\tt L} in which {\tt x} has been inserted into position {\tt i}
Description
Example
Expand Down
6 changes: 3 additions & 3 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/replace-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -68,17 +68,17 @@ doc ///

doc ///
Key
(replace, ZZ, Thing, VisibleList)
(replace, ZZ, Thing, BasicList)
Headline
copy a list, replacing an element
Usage
s = replace(i, t, l)
Inputs
i:ZZ
t:Thing
l:VisibleList
l:BasicList
Outputs
s:VisibleList
s:BasicList
a copy of the list @TT "l"@ in which @TT "t"@ has replaced the element at position @TT "i"@.
Description
Text
Expand Down
6 changes: 3 additions & 3 deletions M2/Macaulay2/packages/Macaulay2Doc/functions/switch-doc.m2
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
doc///
Key
switch
(switch,ZZ,ZZ,VisibleList)
(switch,ZZ,ZZ,BasicList)
Headline
copy a list, switching two elements
Usage
switch(i, j, L)
Inputs
i: ZZ
j: ZZ
L: VisibleList
L: BasicList
Outputs
L2:
L2: BasicList
a copy of the list {\tt L}, with the elements in positions {\tt i} and {\tt j} interchanged.
Description
Text
Expand Down

0 comments on commit 56f37a0

Please sign in to comment.