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

Improve data types page #745

Merged
merged 2 commits into from
Feb 13, 2024
Merged

Improve data types page #745

merged 2 commits into from
Feb 13, 2024

Conversation

rgommers
Copy link
Member

This is largely a reorganization to improve the readability of this page, by replacing many subheadings with tables, by removing duplication in notes, and by reorganizing content.

Furthermore, the description on how dtype objects are used is extended:

  • add more ways in which dtype objects are used
  • explain that dtype= keywords determine output dtype and not internal/intermediate calculation dtype of arrays
  • cross-link type promotion rules

The end result is that the page length is ~25% shorter and the sidebar navigation ~8x shorter, while adding some useful content.

@rgommers rgommers added the Narrative Content Narrative documentation content. label Feb 10, 2024
This is large a reorganization to improve the readability of this page,
by replacing many subheadings with tables, by removing duplication
in notes, and by reorganizing content.

Furthermore, the description on how dtype objects are used is extended:
- add more ways in which dtype objects are used
- explain that `dtype=` keywords determine output dtype and not
  internal/intermediate calculation dtype of arrays
- cross-link type promotion rules
@leofang
Copy link
Contributor

leofang commented Feb 12, 2024

Didn't review in detail but I love tables!

@kgryte kgryte added this to the v2023 milestone Feb 13, 2024
Copy link
Contributor

@kgryte kgryte 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, @rgommers!

@kgryte kgryte merged commit 2404c99 into data-apis:main Feb 13, 2024
3 checks passed
@rgommers rgommers deleted the improve-dtype-page branch February 13, 2024 09:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Narrative Content Narrative documentation content.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants