docs: Add note on return type of columns property#3575
Open
docs: Add note on return type of columns property#3575
Conversation
EdAbati
reviewed
Apr 26, 2026
Comment on lines
+1357
to
+1359
| The pandas-like and dask backends allow non-string column names | ||
| (e.g. integers or booleans). While discouraged, this is supported, | ||
| so the return type is not guaranteed to be `list[str]`. |
Collaborator
There was a problem hiding this comment.
I think the phrasing looks good!
I tried to find alternatives.
For the 2nd sentence we can use something like:
This is discouraged but supported, so the return type is not guaranteed to be list[str].
Or have it all one sentence:
Non-string column names (e.g. integers or booleans) are discouraged but supported by pandas-like and Dask backends, so the return type is not guaranteed to be list[str].
But again, I think your version looks good :)
Collaborator
Do you mean in We could also update the |
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Schemaspec? For the same reason we cannot guarantee it to be a Mapping from str to DType.What type of PR is this? (check all applicable)
Related issues