Add ProperyGraph to doc generation and update docstrings #2826
Conversation
There was a problem hiding this comment.
There seems to still be some inconsistencies here, mainly in that some APIs have examples, others don't, the format for how params are described seems different for different APIs, some APIs still don't have docstrings at all, etc. For the missing docstrings: if you intend to do just some of the APIs now and the rest later, then I can just review what's here with the assumption that more will follow later.
|
I forgot to mention: if you intend to do just some of the APIs now and the rest later, then I can just review what's here with the assumption that more will follow later, but then this PR probably shouldn't close #2683 |
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## branch-22.12 #2826 +/- ##
===============================================
Coverage ? 60.77%
===============================================
Files ? 122
Lines ? 6880
Branches ? 0
===============================================
Hits ? 4181
Misses ? 2699
Partials ? 0 Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. ☔ View full report at Codecov. |
|
rerun tests |
There was a problem hiding this comment.
The updated "Parameters" sections look good. I still see a lot of (possibly new?) indentation errors. Also, I noticed the doctest test doesn't appear to be running on this file for some reason (when I ran it locally, I didn't see any results for these source files), so can you please also fix test_doctests.py to ensure it's covering these files?
|
rerun tests |
|
@gpucibot merge |
closes #2683