Skip to content

DOC: tweaks and fixes for string functionality docs - #32755

Merged
ngoldbaum merged 1 commit into
numpy:mainfrom
ngoldbaum:stringdtype-docs-fixes
Sep 24, 2026
Merged

ngoldbaum merged 1 commit into
numpy:mainfrom
ngoldbaum:stringdtype-docs-fixes

Conversation

@ngoldbaum

Copy link
Copy Markdown
Member

PR summary

Fixes a number of minor issues and inaccuracies in the docs.

  • Using r"" strings in the docstrings for encode and decode is necessary because there are inline control characters.
  • Refer to null-padded strings instead of zero-padded or null-terminated strings
  • Correct docs that predate StringDType short string support
  • Don't talk about raw bytes as an encoding.

AI Disclosure

An AI helped me spot these problems as part of work on bytestringdtype.

ngoldbaum added a commit to ngoldbaum/numpy that referenced this pull request Sep 23, 2026
ngoldbaum added a commit to ngoldbaum/numpy that referenced this pull request Sep 23, 2026
@ngoldbaum ngoldbaum mentioned this pull request Sep 23, 2026
2 of 4 tasks
ngoldbaum added a commit to ngoldbaum/numpy that referenced this pull request Sep 24, 2026
ngoldbaum added a commit to ngoldbaum/numpy that referenced this pull request Sep 24, 2026

@ikrommyd ikrommyd left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

All look right to me!

@ngoldbaum
ngoldbaum merged commit e0e69cd into numpy:main Sep 24, 2026
92 checks passed
ngoldbaum added a commit to ngoldbaum/numpy that referenced this pull request Sep 24, 2026
Riaz1729 pushed a commit to Riaz1729/numpy that referenced this pull request Sep 29, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants