Project

General

Profile

Support #522

Manual: duplication in "see also" and "All other matches"

Added by John Abbott about 10 years ago. Updated over 8 years ago.

Status:
Closed
Priority:
Normal
Category:
Manual/documentation
Start date:
04 Apr 2014
Due date:
% Done:

100%

Estimated time:
2.00 h
Spent time:

Description

In some cases there is duplication in the lists of "See also" and "All other matches".

A specific instance is:

?round
...
See also:
 ? num
 ? den
 ? floor
 ? ceil

All 2 other matches for "round":
 ? ceil
 ? floor

History

#1 Updated by John Abbott about 10 years ago

JAA does not like the duplication:
  • it makes us look inept (why didn't we bother to "clean" one of the lists?)
  • it wastes vertical space (the actual manual entry scrolls up out of sight)

#2 Updated by John Abbott about 10 years ago

The "See also" list is determined by whoever wrote the manual entry (its contents are "handwritten").

The "All other matches" is generated automatically.

I suggest using the title "All further matches", and then listing only those entries not already mentioned in "See also". If there are too many "further matches" then there should be a message like "There are also N further matches for XYZ".

#3 Updated by Anna Maria Bigatti almost 10 years ago

  • Status changed from New to Feedback
  • % Done changed from 0 to 90
  • Estimated time set to 2.00 h

Seems ok on round and indets.
(code in OnlineHelp is pretty horrible, but it works)

#4 Updated by John Abbott almost 9 years ago

  • Target version changed from CoCoA-5.?.? to CoCoA-5.1.2 summer 2015

#5 Updated by Anna Maria Bigatti over 8 years ago

  • Status changed from Feedback to Closed
  • Assignee set to Anna Maria Bigatti
  • % Done changed from 90 to 100

Also available in: Atom PDF