Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix all unexecutable code examples I can find. #693

Merged
merged 1 commit into from
Sep 27, 2022

Conversation

thomcom
Copy link
Contributor

@thomcom thomcom commented Sep 26, 2022

Description

A few old issues that are tasked for 22.10 involve fixing documentation that is incorrect. I worked through the existing nightly docs and executed all of the code samples, fixing and improving anything that had incorrect outputs or inputs.

closes #460
closes #63

Checklist

  • I am familiar with the Contributing Guidelines.
  • New or existing tests cover these changes.
  • The documentation is up to date with these changes.

@github-actions github-actions bot added the Python Related to Python code label Sep 26, 2022
@@ -133,7 +133,8 @@ def _split_out_geometry_columns(self) -> Tuple:
"""
columns_mask = pd.Series(self.columns)
geocolumn_mask = pd.Series(
[isinstance(self[col], GeoSeries) for col in self.columns]
[isinstance(self[col], GeoSeries) for col in self.columns],
dtype="bool",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Pandas was issuing a warning on this line so I corrected that warning.

@thomcom thomcom added bug Something isn't working 3 - Ready for Review Ready for review by team non-breaking Non-breaking change labels Sep 26, 2022
@thomcom thomcom marked this pull request as ready for review September 26, 2022 20:07
@thomcom thomcom requested a review from a team as a code owner September 26, 2022 20:07
@thomcom thomcom requested a review from cwharris September 26, 2022 20:07
@harrism harrism requested review from harrism and isVoid and removed request for cwharris September 27, 2022 02:17
Copy link
Member

@harrism harrism left a comment

Choose a reason for hiding this comment

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

Thank you Thomson! Fixing these old smelly bits is really important and really improves UX of our library.

Copy link
Contributor

@isVoid isVoid left a comment

Choose a reason for hiding this comment

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

At some point we should introduce doctest to cuspatial.

@thomcom
Copy link
Contributor Author

thomcom commented Sep 27, 2022

@gpucibot merge

@rapids-bot rapids-bot bot merged commit 5d84d9e into rapidsai:branch-22.10 Sep 27, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
3 - Ready for Review Ready for review by team bug Something isn't working non-breaking Non-breaking change Python Related to Python code
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

[DOC] cuSpatial Documentation Example Errors [DOC] Trajectory.py docs are out of date
3 participants