DOC: Replace @appender with inlined docstrings in pandas/io/parsers/readers.py #62713
+936
−35
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
huhu-dsy
commented
Oct 16, 2025
huhu-dsy
commented
- contributes to DOC: Replace @appender, @substitution, @doc with inlined docstrings https://github.com/pandas-- dev/pandas/issues/62437
- [Tests added and passed]if fixing a bug or adding a new feature
- All [code checks passed]
- Added [type annotations]to new arguments/methods/functions.
- Added an entry in the latest doc/source/whatsnew/vX.X.X.rst file if fixing a bug or adding a new feature.
mroeschke
reviewed
Oct 16, 2025
Comment on lines
+878
to
+885
| Column(s) to use as row label(s), denoted either by column labels or column | ||
| indices. If a sequence of labels or indices is given, | ||
| :class:`~pandas.MultiIndex` | ||
| will be formed for the row labels. | ||
| Note: ``index_col=False`` can be used to force pandas to *not* use the first | ||
| column as the index, e.g., when you have a malformed file with delimiters at | ||
| the end of each line. |
There was a problem hiding this comment.
The indentation of this section seems different than the others
mroeschke
reviewed
Oct 16, 2025
Comment on lines
+1148
to
+1153
| .. versionadded:: 1.3.0 | ||
| .. versionadded:: 1.4.0 | ||
| Callable | ||
There was a problem hiding this comment.
Suggested change
| .. versionadded:: 1.3.0 | |
| .. versionadded:: 1.4.0 | |
| Callable |
This section looked odd, but these are old versions so we can remove
mroeschke
reviewed
Oct 16, 2025
Comment on lines
+1466
to
+1472
| Column(s) to use as row label(s), denoted either by column labels or column | ||
| indices. If a sequence of labels or indices is given, :class:`~pandas.MultiIndex` | ||
| will be formed for the row labels. | ||
| Note: ``index_col=False`` can be used to force pandas to *not* use the first | ||
| column as the index, e.g., when you have a malformed file with delimiters at | ||
| the end of each line. |
There was a problem hiding this comment.
Same indentation comment here
mroeschke
reviewed
Oct 16, 2025
Comment on lines
+1732
to
+1737
| .. versionadded:: 1.3.0 | ||
| .. versionadded:: 1.4.0 | ||
| Callable | ||
There was a problem hiding this comment.
Suggested change
| .. versionadded:: 1.3.0 | |
| .. versionadded:: 1.4.0 | |
| Callable |
mroeschke
reviewed
Oct 16, 2025
|
|
||
|
|
||
| @Appender( | ||
| _doc_read_csv_and_table.format( |
There was a problem hiding this comment.
If _doc_read_csv_and_table is not used anywhere else, can you remove it?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.