Project

General

Profile

Support #1265

Unregistered TXT files in doc

Added by John Abbott about 5 years ago. Updated 2 months ago.

Status:
Closed
Priority:
High
Assignee:
Category:
Documentation
Target version:
Start date:
27 Mar 2019
Due date:
% Done:

100%

Estimated time:
2.50 h
Spent time:

Description

There are some "unregistered" .txt files in the CoCoALib documentation.

Rectify!


Related issues

Related to CoCoALib - Support #1510: Documentation for SparsePolyOps?New2020-10-14

Related to CoCoALib - Design #1783: Code & doc structure: one-big-file or many-small-files?In Progress2024-02-24

History

#1 Updated by John Abbott about 5 years ago

These files exist but are not present in index-alpha.html.

00CodingConventions.txt [[2023-03-09  now it is indexed]]
00INTRODUCTION.txt     [[2023-03-09  now it is indexed]]
--ApproxPts.txt--      [[2023-03-09  now it is indexed]]
--assert.txt--         [[2023-03-09  now it is indexed]]
-- exception.txt --    [[2023-03-09  now it is indexed]]
--ExternalLibs-readline.txt--  [[no longer exists: 2021-11-03]]
--IdealOfPoints.txt--  [[2023-03-09  now it is indexed]]
INSTALL.txt            [[2023-03-09  now it is indexed]]
--SmallPrime.txt--     [[2023-03-09  no longer exists]]
SparsePolyOps.txt      [[2023-03-09  exists but is almost empty]]

I have not checked index.html

#2 Updated by John Abbott over 4 years ago

  • Target version changed from CoCoALib-0.99700 to CoCoALib-0.99800

Postponing because this is not essential for the next release, and choosing status quo seems to be harmless while also saving time.

#3 Updated by John Abbott over 3 years ago

  • Status changed from New to In Progress
  • % Done changed from 0 to 10
Progress chart:
  • SmallPrime.txt removed because very out of date
  • fill in as progress is made

#4 Updated by John Abbott over 2 years ago

  • % Done changed from 10 to 20

I have just added doc for exception to the indexes.

#5 Updated by John Abbott over 2 years ago

  • % Done changed from 20 to 30

The doc for assert had already been added. I have revised the source code in assert.H slightly.

#6 Updated by John Abbott over 2 years ago

  • % Done changed from 30 to 50

I have added a "first" version of doc for IdealOfPoints and IdealOfProjectivePoints.

#7 Updated by John Abbott about 2 years ago

  • Assignee set to John Abbott
  • % Done changed from 50 to 70

There is a file called SparsePolyOps.txt which seems to be devoid of meaningful content.
There are several files whose names begin SparsePolyOps-.
I suggest simply deleting SparsePolyOps.txt -- OK, Anna?

#8 Updated by John Abbott about 2 years ago

  • Target version changed from CoCoALib-0.99800 to CoCoALib-0.99850

#9 Updated by John Abbott about 1 year ago

Let's discuss this issue. I hope we can resolve it this week.

#10 Updated by John Abbott about 1 year ago

  • Status changed from In Progress to Resolved
  • % Done changed from 70 to 90

The only remaining case is SparsePolyOps.txt which is almost empty...
BUT there are several other files SparsePolyOps-XYZ.

Perhaps these other files should be merged into a single file somewhere?
(either a new file, or an existing file).

#11 Updated by John Abbott about 1 year ago

  • Related to Support #1510: Documentation for SparsePolyOps? added

#12 Updated by John Abbott 2 months ago

  • Status changed from Resolved to Closed
  • % Done changed from 90 to 100
  • Estimated time set to 2.50 h

#13 Updated by Anna Maria Bigatti about 2 months ago

  • Related to Design #1783: Code & doc structure: one-big-file or many-small-files? added

Also available in: Atom PDF