Skip to content

Add ProperyGraph to doc generation and update docstrings#2826

Merged
rapids-bot[bot] merged 33 commits intorapidsai:branch-22.12from
acostadon:rst_work_issue_2683
Nov 14, 2022
Merged

Add ProperyGraph to doc generation and update docstrings#2826
rapids-bot[bot] merged 33 commits intorapidsai:branch-22.12from
acostadon:rst_work_issue_2683

Conversation

@acostadon
Copy link
Contributor

closes #2683

@acostadon acostadon added doc Documentation non-breaking Non-breaking change labels Oct 19, 2022
@acostadon acostadon self-assigned this Oct 19, 2022
@acostadon acostadon added this to the 22.12 milestone Oct 19, 2022
@acostadon acostadon marked this pull request as ready for review October 21, 2022 13:00
@acostadon acostadon requested review from a team as code owners October 21, 2022 13:00
Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@rlratzel
Copy link
Contributor

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-commenter
Copy link

codecov-commenter commented Oct 25, 2022

Codecov Report

❗ No coverage uploaded for pull request base (branch-22.12@ffa4a6d). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head b8de367 differs from pull request most recent head 225cc1c. Consider uploading reports for the commit 225cc1c to get more accurate results

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

@acostadon acostadon requested a review from rlratzel October 27, 2022 01:20
@acostadon
Copy link
Contributor Author

rerun tests

@acostadon acostadon requested a review from rlratzel November 4, 2022 00:07
Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@acostadon acostadon requested a review from rlratzel November 9, 2022 15:07
@acostadon
Copy link
Contributor Author

rerun tests

Copy link
Contributor

@rlratzel rlratzel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM pending suggested (very small) changes.

I will try to write my docstrings more like this. Love it.

@acostadon acostadon requested a review from eriknw November 14, 2022 12:38
Copy link
Contributor

@eriknw eriknw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

@BradReesWork
Copy link
Member

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 3803cf8 into rapidsai:branch-22.12 Nov 14, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Documentation non-breaking Non-breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[DOC] SG Property Graph API docs

5 participants