Project

General

Profile

Support #1350

CoCoA manual: entry for operators, shortcuts

Added by John Abbott over 4 years ago. Updated about 2 years ago.

Status:
New
Priority:
Normal
Assignee:
-
Category:
Manual/documentation
Target version:
CoCoA-5.4.2
Start date:
25 Oct 2019
Due date:
% Done:

0%

Estimated time:
Spent time:
1.45 h

Description

The first time I use the online manual in CoCoA-5, I always get a warning about the operators, shortcuts page being out of order.

It would be nice to resolve this... it looks "unprofessional".

Also that manual page is long and hard to read/comprehend.

Might it be better to make the page into a tutorial?

I also noticed that only < is present, while <= and > and >= are absent.

Related issues

Related to CoCoA-5 - Bug #1055: CoCoAManual: duplication (2 pages for operators)Closed2017-04-28

History

#1 Updated by John Abbott over 4 years ago

  • Related to Bug #1055: CoCoAManual: duplication (2 pages for operators) added

#2 Updated by John Abbott over 4 years ago

I have added <= and > and >= to the list at the top of the page.

I also noticed that there appears to be a mess regarding arg types and return types; this should be tidied up.

I would like there to be quite a short page about operators, perhaps just with links to other pages where more details are given. I find the current page too long and hard to digest.

#3 Updated by John Abbott over 4 years ago

The standard arithmetic operators were not listed (plus, minus, times, divide, power). Maybe others too? We should check!

Fixing this properly will likely take lots of time; I suggest postponing.

#4 Updated by John Abbott over 4 years ago

  • Target version changed from CoCoA-5.3.0 to CoCoA-5.4.0

#5 Updated by John Abbott about 4 years ago

I suggest breaking the page into subsections (or even splitting it into more than one page?): e.g. comparison operators, arithmetic operators, list ctors, etc.

#6 Updated by John Abbott about 4 years ago

  • Description updated (diff)

We need to review the purpose of this manual entry.

Maybe it should have little content, but simplify refer to other manual pages. We can have shorter pages about sensible groupings of operators:
  • equality and not-equality
  • order comparisons
  • assignment (normal and for rings)
  • indexing operators (lists, matrices, records, strings)
  • arithmetic operators
  • others(???)

#7 Updated by John Abbott about 2 years ago

  • Target version changed from CoCoA-5.4.0 to CoCoA-5.4.2

Also available in: Atom PDF