Design #168
Type info in CoCoA-5 manual
Status:
Closed
Priority:
Normal
Assignee:
Category:
Manual/documentation
Target version:
Description
The manual entries in CoCoAHelp.xml include a collection of the types involved.
What convention should be used for the names of these types?
For instance the fn abs
lists as its types integer
, rat
and ringlem
.
Decide a convention, and apply it (as uniformly as possible).
- 2019-10 ** here it is (this allows generating manual page with all functions returning INT, RAT, ...)
<syntax> abs(N: <type>INT</type>): <rtn>INT</rtn> abs(N: <type>RAT</type>): <rtn>RAT</rtn> abs(N: <type>RINGELEM</type>): <rtn>RINGELEM</rtn> </syntax>
Related issues
History
#1
Updated by Anna Maria Bigatti over 10 years ago
- Target version set to CoCoA-5.1.0 Easter14
#2
Updated by John Abbott about 10 years ago
- Target version changed from CoCoA-5.1.0 Easter14 to CoCoA-5.?.?
#3
Updated by John Abbott almost 6 years ago
- Status changed from New to In Progress
- Target version changed from CoCoA-5.?.? to CoCoA-5.3.0
- % Done changed from 0 to 50
I think that has already been (mostly) done. Right?
Setting new target version.
#4
Updated by John Abbott almost 5 years ago
Can we close this now?
#5
Updated by Anna Maria Bigatti over 4 years ago
- Subject changed from Type info in C5 manual to Type info in CoCoA-5 manual
- Description updated (diff)
- Status changed from In Progress to Closed
- Assignee set to Anna Maria Bigatti
- % Done changed from 50 to 100
#6
Updated by Anna Maria Bigatti over 4 years ago
- Related to Bug #1320: CoCoA-5 manual: incorrect empty line in syntax box (in PDF file) added
#7
Updated by Anna Maria Bigatti over 4 years ago
- Related to Support #1024: CoCoA Manual: consistent spacing in VarName: TYPE added
#8
Updated by Anna Maria Bigatti over 4 years ago
- Related to Support #542: CoCoAManual: improve part on data-types added
#9
Updated by Anna Maria Bigatti 20 days ago
- Tracker changed from Bug to Design
#10
Updated by Anna Maria Bigatti 20 days ago
- Related to Bug #1820: Manual: why doesn't "?Commands and Functions for STRING" show the function RingElem? added