Skip to content

Wrong argument documentation for reindex_axis #23960

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

Closed
dargueta opened this issue Nov 28, 2018 · 4 comments · Fixed by eahogue/pandas#1 or #24105
Closed

Wrong argument documentation for reindex_axis #23960

dargueta opened this issue Nov 28, 2018 · 4 comments · Fixed by eahogue/pandas#1 or #24105

Comments

@dargueta
Copy link
Contributor

dargueta commented Nov 28, 2018

Problem description

The documentation for DataFrame.reindex_axis() has incorrect documentation for the arguments. The function signature is correct, but the description of fill_value is missing and there's a description of a tolerance argument that isn't accepted by the actual method. This can cause crashes or bad data due to incorrect use of the method.

Expected Output

Documentation for the tolerance argument should be removed, and a description of the fill_value argument should be added.

Output of pd.show_versions()

INSTALLED VERSIONS

commit: None
python: 3.7.0.final.0
python-bits: 64
OS: Darwin
OS-release: 17.7.0
machine: x86_64
processor: i386
byteorder: little
LC_ALL: None
LANG: en_US.UTF-8
LOCALE: en_US.UTF-8

pandas: 0.23.4
pytest: None
pip: 18.1
setuptools: 40.6.2
Cython: 0.29.1
numpy: 1.15.4
scipy: None
pyarrow: 0.11.1
xarray: None
IPython: None
sphinx: None
patsy: None
dateutil: 2.7.5
pytz: 2018.7
blosc: None
bottleneck: None
tables: 3.4.4
numexpr: 2.6.8
feather: None
matplotlib: None
openpyxl: None
xlrd: None
xlwt: None
xlsxwriter: None
lxml: None
bs4: None
html5lib: None
sqlalchemy: 1.2.14
pymysql: None
psycopg2: 2.7.6.1 (dt dec pq3 ext lo64)
jinja2: None
s3fs: 0.2.0
fastparquet: 0.2.0
pandas_gbq: None
pandas_datareader: None

@chris-b1 chris-b1 added this to the Contributions Welcome milestone Nov 29, 2018
@eahogue
Copy link
Contributor

eahogue commented Nov 30, 2018

Hi, I can take care of this if no one else is working on it.

@eahogue
Copy link
Contributor

eahogue commented Nov 30, 2018

Hm, just a clarification. I don't see a fill_na argument, but there is fill_value which doesn't have a description. Is that the argument you meant?

I'm looking here.

@dargueta
Copy link
Contributor Author

dargueta commented Dec 1, 2018

Agh yeah that's what I meant. Nice catch! I've updated the original report.

@eahogue
Copy link
Contributor

eahogue commented Dec 4, 2018

Please take a look. I am not very savvy with github so pls let me know if I should do anything differently.

@jorisvandenbossche jorisvandenbossche modified the milestones: Contributions Welcome, 0.24.0 Dec 9, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
4 participants