Skip to content
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

DOC: Make API reference intro section concise #19846

Merged
merged 1 commit into from
Feb 26, 2018

Conversation

wla80
Copy link

@wla80 wla80 commented Feb 22, 2018

Also revise the typo "in not guaranteed" to "is not guaranteed"

revise the typo "in not guaranteed" to "is not guaranteed"
``pandas.io`` and ``pandas.tseries`` submodules are public as well (those
mentioned in the documentation). Further, the ``pandas.api.types`` subpackage
holds some public functions related to data types in pandas.
Some subpackages are public which include ``pandas.errors``,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

these all could be references

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hello @jreback , sorry, I don't understand your comment. Could you clarify what are the further changes that I need to address for this commit? Thanks a lot.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

use :module:`pandas.errors` and so on

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just uploaded a new fix. Please let me know if I am still doing it wrong. Thanks

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jreback we don't have module docstring pages, so I don't think such links will work

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @jorisvandenbossche , thanks for the clarification. Just revert the commit back to origin: dccfee5

@codecov
Copy link

codecov bot commented Feb 24, 2018

Codecov Report

Merging #19846 into master will increase coverage by 0.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master   #19846      +/-   ##
==========================================
+ Coverage   91.66%   91.68%   +0.01%     
==========================================
  Files         150      150              
  Lines       48938    48915      -23     
==========================================
- Hits        44860    44847      -13     
+ Misses       4078     4068      -10
Flag Coverage Δ
#multiple 90.06% <ø> (+0.01%) ⬆️
#single 41.83% <ø> (+0.01%) ⬆️
Impacted Files Coverage Δ
pandas/core/dtypes/common.py 94.16% <0%> (-0.49%) ⬇️
pandas/core/indexes/period.py 92.86% <0%> (-0.48%) ⬇️
pandas/core/groupby.py 92.2% <0%> (-0.11%) ⬇️
pandas/core/indexes/timedeltas.py 90.94% <0%> (-0.06%) ⬇️
pandas/core/indexes/datetimelike.py 97.37% <0%> (-0.02%) ⬇️
pandas/core/generic.py 95.93% <0%> (+0.04%) ⬆️
pandas/core/frame.py 97.23% <0%> (+0.05%) ⬆️
pandas/core/dtypes/cast.py 87.98% <0%> (+0.29%) ⬆️
pandas/plotting/_converter.py 66.95% <0%> (+1.73%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 92dbc78...dccfee5. Read the comment docs.

@jorisvandenbossche jorisvandenbossche changed the title DOC: Make API reference section concise DOC: Make API reference intro section concise Feb 26, 2018
@jorisvandenbossche jorisvandenbossche merged commit 2f09f86 into pandas-dev:master Feb 26, 2018
@jorisvandenbossche
Copy link
Member

Thanks!

harisbal pushed a commit to harisbal/pandas that referenced this pull request Feb 28, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants