Description

sneakers-the-rat

opened on Apr 17, 2023

Issue body actions

The Operations docs

have examples like

A = gb.Matrix.from_coo([0, 0, 1, 1, 2], [1, 2, 0, 2, 1],
                       [2.0, 5.0, 1.5, 4.0, 0.5])
B = gb.Matrix.from_coo([0, 0, 1, 1, 2, 2], [1, 2, 0, 1, 1, 2],
                       [3., -2., 0., 6., 3., 1.])

# These are equivalent
C << A.ewise_mult(B, op='min')  # method style
C << gb.binary.min(A & B)  # functional style

but when I try and do either of these I get 'C' is not defined which is what I expected from prior documentation. Would recommend making these doctests so that the docs don't include erroneous examples

part of: pyOpenSci/software-submission#81

Activity

1. eriknw

   added

   bugSomething is brokenSomething is broken

   documentationImprove or add to documentationImprove or add to documentation

   on Apr 18, 2023
2. eriknw commented on Apr 18, 2023

   

   eriknw

   on Apr 18, 2023

   Member

   More actions

   Thanks for the report! I consider this a bug. Code examples should be copy/paste-able.

   I'm also a big fan of using doctests for ensuring correctness, so I'll add this as an item on our roadmap.
3. eriknw

   closed this as completedin #440on Apr 19, 2023

Issue actions