Documentation Todos

[mlesnick]

The RIVET documentation has improved a lot recently, but still needs some work. A detailed list of todos is at the bottom of the about page in the documentation.

[mlesnick]

Major updates to the documentation are in the works to accompany improvements to RIVET handling of input data.

Also, here is one significant omission in documentation: In the case of descending coordiantes, the documentation does not explain the parameterization used by RIVET when printing barcodes to the console using the --barcodes flag. Changing one coordinate direction effectively makes the slope of the line negative, so that the rule described in the documentation doesn't apply. I expect that the rule which has been implemented is to unflip the flipped coordinate direction by multiplying this coordinate by -1, and then use the rule described in the documentation. But this should be checked.

[mlwright84]

The documentation has been updated to describe the new file input formats and flags that Anway has implemented since 2019.

Here are two todos that used to be noted in about.rst:

• In the discussion of the Persistence Diagram Window, some details about how the persistence diagram is drawn appear in the appendix of the arXiv paper, but not in the documentation. For example, the way we handle normalization when "fit to window" is selected is only discussed in the appendix. We suggest that all details be given in the documentation and removed from the paper.
• The examples could use some polish. More examples are desirable.