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

docs: add dtypes check in utils/check_api_reference.py #983

Merged
merged 1 commit into from
Sep 21, 2024

Conversation

FBruzzesi
Copy link
Member

What type of PR is this? (check all applicable)

  • 💾 Refactor
  • ✨ Feature
  • 🐛 Bug Fix
  • 🔧 Optimization
  • 📝 Documentation
  • ✅ Test
  • 🐳 Other

Related issues

Checklist

  • Code follows style guide (ruff)
  • Tests added
  • Documented the changes

@github-actions github-actions bot added documentation Improvements or additions to documentation labels Sep 16, 2024
@@ -28,9 +28,11 @@
"item",
"scatter",
}
BASE_DTYPES = {"NumericType", "DType", "TemporalType"}
Copy link
Member Author

Choose a reason for hiding this comment

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

Shall we document these in the api reference page?

Copy link
Member

@MarcoGorelli MarcoGorelli left a comment

Choose a reason for hiding this comment

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

thanks @FBruzzesi !

for numeric dtype, I think people can use .is_numeric, and set membership for the temporal ones

@MarcoGorelli MarcoGorelli merged commit 76f4edb into main Sep 21, 2024
25 checks passed
@FBruzzesi FBruzzesi deleted the feat/improve-check-api-reference branch September 23, 2024 10:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[doc]: Make DTypes Reference Page
2 participants