Skip to content

Commit 73a69fd

Browse files
authored
DOC: updates documentations Closes #21749 (#42979)
1 parent 2753975 commit 73a69fd

File tree

5 files changed

+17
-21
lines changed

5 files changed

+17
-21
lines changed

pandas/_testing/_io.py

+5-6
Original file line numberDiff line numberDiff line change
@@ -160,19 +160,18 @@ def network(
160160
Tests decorated with @network will fail if it's possible to make a network
161161
connection to another URL (defaults to google.com)::
162162
163-
>>> from pandas._testing import network
164-
>>> from pandas.io.common import urlopen
165-
>>> @network
163+
>>> from pandas import _testing as ts
164+
>>> @ts.network
166165
... def test_network():
167-
... with urlopen("rabbit://bonanza.com"):
166+
... with pd.io.common.urlopen("rabbit://bonanza.com"):
168167
... pass
169168
Traceback
170169
...
171170
URLError: <urlopen error unknown url type: rabit>
172171
173172
You can specify alternative URLs::
174173
175-
>>> @network("https://www.yahoo.com")
174+
>>> @ts.network("https://www.yahoo.com")
176175
... def test_something_with_yahoo():
177176
... raise IOError("Failure Message")
178177
>>> test_something_with_yahoo()
@@ -183,7 +182,7 @@ def network(
183182
If you set check_before_test, it will check the url first and not run the
184183
test on failure::
185184
186-
>>> @network("failing://url.blaher", check_before_test=True)
185+
>>> @ts.network("failing://url.blaher", check_before_test=True)
187186
... def test_something():
188187
... print("I ran!")
189188
... raise ValueError("Failure")

pandas/_testing/asserters.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -303,10 +303,10 @@ def assert_index_equal(
303303
304304
Examples
305305
--------
306-
>>> from pandas.testing import assert_index_equal
306+
>>> from pandas import testing as tm
307307
>>> a = pd.Index([1, 2, 3])
308308
>>> b = pd.Index([1, 2, 3])
309-
>>> assert_index_equal(a, b)
309+
>>> tm.assert_index_equal(a, b)
310310
"""
311311
__tracebackhide__ = True
312312

@@ -794,10 +794,10 @@ def assert_extension_array_equal(
794794
795795
Examples
796796
--------
797-
>>> from pandas.testing import assert_extension_array_equal
797+
>>> from pandas import testing as tm
798798
>>> a = pd.Series([1, 2, 3, 4])
799799
>>> b, c = a.array, a.array
800-
>>> assert_extension_array_equal(b, c)
800+
>>> tm.assert_extension_array_equal(b, c)
801801
"""
802802
if check_less_precise is not no_default:
803803
warnings.warn(
@@ -938,10 +938,10 @@ def assert_series_equal(
938938
939939
Examples
940940
--------
941-
>>> from pandas.testing import assert_series_equal
941+
>>> from pandas import testing as tm
942942
>>> a = pd.Series([1, 2, 3, 4])
943943
>>> b = pd.Series([1, 2, 3, 4])
944-
>>> assert_series_equal(a, b)
944+
>>> tm.assert_series_equal(a, b)
945945
"""
946946
__tracebackhide__ = True
947947

pandas/core/dtypes/base.py

+1-2
Original file line numberDiff line numberDiff line change
@@ -387,8 +387,7 @@ def register_extension_dtype(cls: type_t[ExtensionDtypeT]) -> type_t[ExtensionDt
387387
388388
Examples
389389
--------
390-
>>> from pandas.api.extensions import register_extension_dtype
391-
>>> from pandas.api.extensions import ExtensionDtype
390+
>>> from pandas.api.extensions import register_extension_dtype, ExtensionDtype
392391
>>> @register_extension_dtype
393392
... class MyExtensionDtype(ExtensionDtype):
394393
... name = "myextension"

pandas/io/formats/latex.py

+3-6
Original file line numberDiff line numberDiff line change
@@ -488,9 +488,8 @@ def _select_iterator(self, over: str) -> type[RowStringIterator]:
488488
class LongTableBuilder(GenericTableBuilder):
489489
"""Concrete table builder for longtable.
490490
491-
>>> from pandas import DataFrame
492491
>>> from pandas.io.formats import format as fmt
493-
>>> df = DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
492+
>>> df = pd.DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
494493
>>> formatter = fmt.DataFrameFormatter(df)
495494
>>> builder = LongTableBuilder(formatter, caption='a long table',
496495
... label='tab:long', column_format='lrl')
@@ -578,9 +577,8 @@ def env_end(self) -> str:
578577
class RegularTableBuilder(GenericTableBuilder):
579578
"""Concrete table builder for regular table.
580579
581-
>>> from pandas import DataFrame
582580
>>> from pandas.io.formats import format as fmt
583-
>>> df = DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
581+
>>> df = pd.DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
584582
>>> formatter = fmt.DataFrameFormatter(df)
585583
>>> builder = RegularTableBuilder(formatter, caption='caption', label='lab',
586584
... column_format='lrc')
@@ -625,9 +623,8 @@ def env_end(self) -> str:
625623
class TabularBuilder(GenericTableBuilder):
626624
"""Concrete table builder for tabular environment.
627625
628-
>>> from pandas import DataFrame
629626
>>> from pandas.io.formats import format as fmt
630-
>>> df = DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
627+
>>> df = pd.DataFrame({"a": [1, 2], "b": ["b1", "b2"]})
631628
>>> formatter = fmt.DataFrameFormatter(df)
632629
>>> builder = TabularBuilder(formatter, column_format='lrc')
633630
>>> table = builder.get_result()

pandas/tseries/holiday.py

+2-1
Original file line numberDiff line numberDiff line change
@@ -197,7 +197,8 @@ class from pandas.tseries.offsets
197197
Holiday: July 3rd (month=7, day=3, )
198198
199199
>>> NewYears = Holiday(
200-
... "New Years Day", month=1, day=1, observance=nearest_workday
200+
... "New Years Day", month=1, day=1,
201+
... observance=nearest_workday
201202
... )
202203
>>> NewYears # doctest: +SKIP
203204
Holiday: New Years Day (

0 commit comments

Comments
 (0)