-
-
Notifications
You must be signed in to change notification settings - Fork 18.4k
DOC: Add missing single quote to Timestamp.tz_localize
#59472
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
DOC: Add missing single quote to Timestamp.tz_localize
#59472
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks @rob-sil
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sorry, i was sure the ci failure wouldn't been unrelated, but it appears not to be so:
=================================== FAILURES ===================================
_________________ test_nat_doc_strings[Timestamp.tz_localize] __________________
[gw3] linux -- Python 3.11.9 /home/runner/micromamba/envs/test/bin/python3.11
compare = (<class 'pandas._libs.tslibs.timestamps.Timestamp'>, 'tz_localize')
@pytest.mark.parametrize(
"compare",
(
_get_overlap_public_nat_methods(Timestamp, True)
+ _get_overlap_public_nat_methods(Timedelta, True)
),
ids=lambda x: f"{x[0].__name__}.{x[1]}",
)
def test_nat_doc_strings(compare):
# see gh-17327
#
# The docstrings for overlapping methods should match.
klass, method = compare
klass_doc = getattr(klass, method).__doc__
if klass == Timestamp and method == "isoformat":
pytest.skip(
"Ignore differences with Timestamp.isoformat() as they're intentional"
)
if method == "to_numpy":
# GH#44460 can return either dt64 or td64 depending on dtype,
# different docstring is intentional
pytest.skip(f"different docstring for {method} is intentional")
nat_doc = getattr(NaT, method).__doc__
> assert klass_doc == nat_doc
E AssertionError
pandas/tests/scalar/test_nat.py:335: AssertionError
could you fix it up please
@MarcoGorelli good catch! Sorry about that. Found a couple more cases of that same line. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks @rob-sil
…59472) * Add missing single quote to docstring * More missing single quotes * Clean up a print statement Update docstring for utcoffset
doc/source/whatsnew/vX.X.X.rst
file if fixing a bug or adding a new feature.