Repository navigation
[pyos][docs] - Intra-docs references #428
Description
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
ssnamespace but it's unclear to me where that documentation is
Part of: pyOpenSci/software-submission#81
Activity
eriknw commentedon Jul 11, 2023
Huh. Good question. I have no idea what documentation that is referring to. @jim22k can you take a look?
In general, we have
.ssattributes 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
ssproperty on e.g.Matrixought to be documented in the API Reference too--maybe it's supposed to be but something isn't working anymore.jim22k commentedon Jul 11, 2023
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.