Skip to content

DOC: updated categorical docstring #29068

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

Merged
merged 1 commit into from
Oct 18, 2019
Merged

DOC: updated categorical docstring #29068

merged 1 commit into from
Oct 18, 2019

Conversation

javad94
Copy link
Contributor

@javad94 javad94 commented Oct 18, 2019

  • closes #xxxx
  • tests added / passed (tests failed even on master)
  • passes black pandas
  • passes git diff upstream/master -u -- "*.py" | flake8 --diff
  • whatsnew entry

I think api.types.CategoricalDtype in see also section of pandas.Categorical documentation which does not have any link, is better to point to pandas.CategoricalDtype for better understanding of this type. So I made this change and created a pr.

chrome_2019-10-18_14-22-01

@jreback jreback added Categorical Categorical Data Type Docs labels Oct 18, 2019
@jreback
Copy link
Contributor

jreback commented Oct 18, 2019

hmm the link doesn't work in either location. pd.api.type.CategoricalDtype might be needed here

@javad94
Copy link
Contributor Author

javad94 commented Oct 18, 2019

That's strange. When I build documentation with python make.py html command, it has the link. but when I build them with python make.py --single pandas.Categorical command, it does not have a link. There is a bug in --single switch?

@jreback
Copy link
Contributor

jreback commented Oct 18, 2019

if you only build a single page links are not built by definition as you don’t have anything to link

all build should show the link

@javad94
Copy link
Contributor Author

javad94 commented Oct 18, 2019

Oh, I see. So the link works with the change I made earlier.
image

@jreback jreback added this to the 1.0 milestone Oct 18, 2019
@jreback jreback merged commit 09a9f5f into pandas-dev:master Oct 18, 2019
@jreback
Copy link
Contributor

jreback commented Oct 18, 2019

great thanks @javad94

@javad94
Copy link
Contributor Author

javad94 commented Oct 19, 2019

@jreback Your welcome. Thanks to you too.

HawkinsBA pushed a commit to HawkinsBA/pandas that referenced this pull request Oct 29, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
proost pushed a commit to proost/pandas that referenced this pull request Dec 19, 2019
bongolegend pushed a commit to bongolegend/pandas that referenced this pull request Jan 1, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Categorical Categorical Data Type Docs
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants