Description

sneakers-the-rat

opened on Apr 10, 2023

Issue body actions

Making a single issue to collect any times the docs refer to some other part of the docs but that reference is unclear. will edit this top issue with any additional probs

• https://python-graphblas.readthedocs.io/en/stable/user_guide/collections.html#opaque-objects says to look to the API docs for documentation of the ss namespace but it's unclear to me where that documentation is

Part of: pyOpenSci/software-submission#81

Activity

1. eriknw

   added

   documentationImprove or add to documentationImprove or add to documentation

   on Apr 12, 2023
2. eriknw commented on Jul 11, 2023

   

   eriknw

   on Jul 11, 2023

   Member

   More actions

   Huh. Good question. I have no idea what documentation that is referring to. @jim22k can you take a look?

   In general, we have .ss attributes on classes (Matrix, Vector), objects (A.ss, v.ss), and modules (gb.binary.ss).

   We the addition of the SuiteSparse:GraphBLAS JIT, the docs website probably does need a SuiteSparse-specific section. The ss property on e.g. Matrix ought to be documented in the API Reference too--maybe it's supposed to be but something isn't working anymore.
3. jim22k commented on Jul 11, 2023

   

   jim22k

   on Jul 11, 2023

   Member

   More actions

   I think our docstrings used to mention Suitespare-specific settings, so those could be found throughout the API section.

   Refactoring likely broke this and requires an update to the API docs.

Issue actions