GH-45003: [Python][Docs] Update docstrings for metadata methods on Field and Schema classes #45004
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.
Rationale for this change
The docstrings here are not completely accurate. See #45003.
I looked at whether it would make more sense or be more natural for methods like these to return an empty
dict
instead of None and I think None feels better from an API design and usage perspective.What changes are included in this PR?
Updated docstrings to reflect actual behavior.
Are these changes tested?
While the changes don't need testing, I did check to see if we have unit tests for the behavior that's been documented here. We do.
Are there any user-facing changes?
Accurate docs.