docs: improve NumPy-style docstrings in scene module#455
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #455 +/- ##
==========================================
- Coverage 89.39% 88.24% -1.15%
==========================================
Files 27 27
Lines 1282 1285 +3
==========================================
- Hits 1146 1134 -12
- Misses 136 151 +15 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
IgorTatarnikov
left a comment
There was a problem hiding this comment.
Looks good, thanks @AlgoFoe!
Just a few small comments in line. Could you also add more information in the return sections? I've provided one example in line.
| """ | ||
| Main scene in brainrender. | ||
|
|
||
| Coordinates what should be rendered and how it should look. |
There was a problem hiding this comment.
Just a small wording change!
| Coordinates what should be rendered and how it should look. | |
| Coordinates the actors and the overall appearance. |
| def add(self, *items, names=None, classes=None, transform=True, **kwargs): | ||
| def add( | ||
| self, | ||
| *items: object, |
There was a problem hiding this comment.
I don't think object is the correct type here. I'm not sure what the convention is, but my instinct is Mesh | Actor | str | Path but I'm not sure on the convention for *arg type annotation.
| Returns | ||
| ------- | ||
| Actor or list of Actor or None |
There was a problem hiding this comment.
| Returns | |
| ------- | |
| Actor or list of Actor or None | |
| Returns | |
| ------- | |
| Actor or list of Actor or None | |
| The actors added to the scene. None if no actors added. |
Description
What is this PR
Why is this PR needed?
What does this PR do?
scene.py.References
How has this PR been tested?
Is this a breaking change?
Does this PR require an update to the documentation?
Checklist: