Skip to content

Commit 5e85114

Browse files
committed
Add more cross ref at see also section
1 parent d84ffb2 commit 5e85114

File tree

1 file changed

+15
-7
lines changed

1 file changed

+15
-7
lines changed

pandas/io/parsers.py

+15-7
Original file line numberDiff line numberDiff line change
@@ -269,6 +269,7 @@
269269
tupleize_cols : bool, default False
270270
Leave a list of tuples on columns as is (default is to convert to
271271
a MultiIndex on the columns).
272+
272273
.. deprecated:: 0.21.0
273274
This argument will be removed and will always convert to MultiIndex
274275
@@ -311,6 +312,7 @@
311312
312313
See Also
313314
--------
315+
to_csv : Write DataFrame to a comma-separated values (csv) file.
314316
%s
315317
316318
Examples
@@ -334,17 +336,21 @@
334336
Alias for sep.
335337
"""
336338

337-
_see_also = ("to_csv : Write DataFrame to "
338-
"a comma-separated values (csv) file.")
339+
_see_also_csv_doc = ('read_csv : Read a comma-separated values '
340+
'(csv) file into DataFrame.')
341+
342+
_see_also_fwf_doc = ('read_fwf : Read a table of '
343+
'fixed-width formatted lines into DataFrame.')
339344

340345
_example_doc = "pd.{_api}('/tmp/data.csv')"
341346

342347
_read_csv_doc = """
343-
Read CSV (comma-separated) file into DataFrame.
348+
Read a comma-separated values (csv) file into DataFrame.
344349
345350
%s
346-
""" % (_parser_params % (_sep_doc.format(default="','"), _engine_doc,
347-
_see_also, _example_doc.format(_api='read_csv')))
351+
""" % (_parser_params % (_sep_doc.format(default="','"),
352+
_engine_doc, _see_also_fwf_doc,
353+
_example_doc.format(_api='read_csv')))
348354

349355
_read_table_doc = """
350356
Read general delimited file into DataFrame.
@@ -354,7 +360,8 @@
354360
355361
%s
356362
""" % (_parser_params % (_sep_doc.format(default="\\t (tab-stop)"),
357-
_engine_doc, _see_also,
363+
_engine_doc,
364+
'{}\n{}'.format(_see_also_csv_doc, _see_also_fwf_doc),
358365
_example_doc.format(_api='read_table')))
359366

360367
_fwf_widths = """\
@@ -377,7 +384,8 @@
377384
Read a table of fixed-width formatted lines into DataFrame.
378385
379386
%s
380-
""" % (_parser_params % (_fwf_widths, '', _see_also,
387+
""" % (_parser_params % (_fwf_widths, '',
388+
_see_also_csv_doc,
381389
_example_doc.format(_api='read_fwf')))
382390

383391

0 commit comments

Comments
 (0)