Skip to content

docs: name the dehumanize() parameter the way the signature does - #1355

Open
hxperl wants to merge 1 commit into
arrow-py:masterfrom
hxperl:docs-dehumanize-param-name
Open

hxperl wants to merge 1 commit into
arrow-py:masterfrom
hxperl:docs-dehumanize-param-name

Conversation

@hxperl

@hxperl hxperl commented Sep 15, 2026 •

Copy link
Copy Markdown

Arrow.dehumanize() documents a parameter that does not exist — the docstring names string, but the parameter is input_string:

:param string: The humanized string to dehumanize.
def dehumanize(self, input_string: str, locale: str = "en_us") -> "Arrow":

Sphinx drops a :param: whose name does not match the signature, so the parameter renders undocumented. Fixed the docstring to say input_string.

Arrow.dehumanize() takes `input_string`, but its docstring documents
`timestring`. Sphinx therefore renders a parameter that does not exist,
and because the phantom name has no annotation to bind to, the rendered
entry also loses its `(str)` type.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01WZdW1VZpdhcpg3c5iFioSr
@codecov

codecov Bot commented Sep 15, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2224255) to head (21b5b44).
✅ All tests successful. No failed tests found.

Additional details and impacted files
@@            Coverage Diff            @@
##            master     #1355   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           10        10           
  Lines         2315      2315           
  Branches       358       358           
=========================================
  Hits          2315      2315           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant