Project

General

Profile

Design #1525

CoCoA Manual: homogenize obsolete/obsolescent entries

Added by Anna Maria Bigatti over 3 years ago. Updated about 2 years ago.

Status:
Closed
Priority:
Normal
Assignee:
Anna Maria Bigatti
Category:
Manual/documentation
Target version:
CoCoA-5.4.0
Start date:
29 Oct 2020
Due date:
% Done:

100%

Estimated time:
2.44 h
Spent time:
2.40 h

Description

I'm cleaning the manual for a homogeous straightforward style for obsolete/obsolescent entries.
Mainly it should just give a link to the replacement function (and say if it's a simple renaming), or explain why it's obsolete and/or how to replace the call in the best way.

Related issues

Related to CoCoA-5 - Feature #1526: EmacsUI: help/manual for selected string -- or just for word with cursor on?Closed2020-10-29

Related to CoCoALib - Design #854: Function MakeTermOrd should be renamed MakeTermOrdMat?Closed2016-03-24

History

#1 Updated by Anna Maria Bigatti over 3 years ago

The section "see also" is handy only for the online version.
Remove them.

Think of an easy way to call the manual on a string in the EmacsUI from the cocoa5 buffer.

#2 Updated by Anna Maria Bigatti over 3 years ago

  • Related to Feature #1526: EmacsUI: help/manual for selected string -- or just for word with cursor on? added

#3 Updated by Anna Maria Bigatti over 3 years ago

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

This is how the renamed ones should look like

<!-- ===  COMMAND  =============================================== -->
<command>
  <title>AffPoincare [OBSOLESCENT]</title>
  <short_description>[OBSOLESCENT] Renamed AffHilbertSeries</short_description>
<description>
Renamed <ttref>AffHilbertSeries</ttref>.
</description>
</command>

#4 Updated by Anna Maria Bigatti over 3 years ago

  • Status changed from New to In Progress
  • % Done changed from 20 to 40

Done up to letter P

#5 Updated by Anna Maria Bigatti over 3 years ago

Possibly add the year

#6 Updated by Anna Maria Bigatti about 2 years ago

Anna Maria Bigatti wrote:

Possibly add the year

The release/date is now shown when the function is called (see obsoloscent.cpkg5) for both obsolete and obsolescent functions.

1 - obsoloscent.cpkg5 is easier to maintain up-to-date because less tedious to do.
2 - Moreover the user is more likely to read an error/warning message than the manual, especially when the message says "this was changed a looong time ago" ;-)

Duplicating info is usually a bad idea, so I would not care much about adding the obsolescence-year in the manual.

#7 Updated by Anna Maria Bigatti about 2 years ago

  • % Done changed from 40 to 70

#8 Updated by Anna Maria Bigatti about 2 years ago

  • Related to Design #854: Function MakeTermOrd should be renamed MakeTermOrdMat? added

#9 Updated by John Abbott about 2 years ago

  • Status changed from In Progress to Closed
  • % Done changed from 70 to 100
  • Estimated time changed from 4.00 h to 2.44 h

Also available in: Atom PDF