apjanke / octave-tablicious

Table (relational, tabular data) implementation for GNU Octave
https://apjanke.github.io/octave-tablicious/
GNU General Public License v3.0
28 stars 11 forks source link

Doco fixup 2024-01 #110

Open apjanke opened 6 months ago

apjanke commented 6 months ago

Some problems with the doco. Want fixes soon, for #108 Reconcile with Statistics OF.

TODO

Details

Bogus bullet lists in texinfo content

For the bogus bullet lists, e.g. string's class doco has this:

## The string class represents strings, where:
##   - Each element of a string array is a single string
##   - A single string is a 1-dimensional row vector of Unicode characters
##   - Those characters are encoded in UTF-8
##     - This last bit depends on the fact that Octave chars are UTF-8 now
##

But that gets rendered like this (HTML):

image

(PDF):

image

(QHelp):

image

Oops.

References

apjanke commented 5 months ago

Moved milestone from 0.4.0 to 0.5.0 because I want to do 0.4.0 soon for Statistics compatibility and some basic fixes, and the relevant items in this ticket for that are fixed now I think. Further items like string doco improvement and switching to a different doc-building tool can wait until the next release.