Skip to content

Commit

Permalink
fix numpydoc: Update reference of pandas TextFileReader
Browse files Browse the repository at this point in the history
This class lives at pandas.io.parsers.TextFileReader, however, there are
no public docs for it and it isn't linked on pandas doc pages either¹.

Use single backticks to disable linking while denoting that it is a class².

¹ https://pandas.pydata.org/pandas-docs/version/1.4/reference/api/pandas.read_csv.html
² https://numpydoc.readthedocs.io/en/latest/format.html#common-rest-concepts
  • Loading branch information
victorlin committed Jan 19, 2023
1 parent 0ec8d20 commit 4375322
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion augur/io/metadata.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ def read_metadata(metadata_file, id_columns=("strain", "name"), chunk_size=None)
Returns
-------
pandas.DataFrame or pandas.TextFileReader
pandas.DataFrame or `pandas.io.parsers.TextFileReader`
Raises
------
Expand Down

0 comments on commit 4375322

Please sign in to comment.