You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I know that adding an example for every single solitary user-facing function can get quite tedious, so I would use your best judgement, but it seems like there should examples for most functions, at least for the core functionality.
The pyOpenSci review requires examples "for all user-facing functions".
My impression reading the API docs is that there are some examples, e.g. for the
load
method of theplenoptic.synthesize.Metamer
class:https://plenoptic.readthedocs.io/en/latest/api/plenoptic.synthesize.html#plenoptic.synthesize.metamer.Metamer.load
But that there are some frequently used methods and functions that do not have examples, e.g.
I know that adding an example for every single solitary user-facing function can get quite tedious, so I would use your best judgement, but it seems like there should examples for most functions, at least for the core functionality.
Probably you will want to add built-in data first as in #235 and then leverage that in the examples.
Looks like you are already set up to use your plots in the docs? https://github.com/LabForComputationalVision/plenoptic/blob/de8f9308d0fcd24050a93b326390eb4444b9aff2/docs/conf.py#L48.
But you might need to do more set up to get images in rendered docstrings, like
https://github.com/librosa/librosa/blob/8dae20c66353190749486abf6b332d93c4ab2b46/docs/conf.py#L107C1-L113C4
The text was updated successfully, but these errors were encountered: