Skip to content

Only use ~ in class ref to hide prefix #78

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 2 commits into from
Mar 13, 2018

Conversation

dukebody
Copy link
Contributor

@dukebody dukebody commented Mar 11, 2018

The current contents are a bit misleading and makes one think it's a typo.

@datapythonista
Copy link
Member

Afaik the ~ is being used to link to classes in pandas. Not sure why, will check.

@TomAugspurger
Copy link

~ hides the class name. We'll occasionally use it when referring to a method on either Series or DataFrame, instead of doing

:meth:`Series.head` or :meth:`DataFrame.head`

@dukebody
Copy link
Contributor Author

Found it! http://www.sphinx-doc.org/en/stable/domains.html#cross-referencing-syntax

I will modify the PR to say this.

@dukebody dukebody changed the title Typo, ref to a class doesn't need ~ Only use ~ in class ref to hide prefix Mar 13, 2018
@dukebody dukebody force-pushed the typo-link-pandas-class branch from c304c4d to 8fd1afb Compare March 13, 2018 07:39
@dukebody dukebody force-pushed the typo-link-pandas-class branch from 8fd1afb to 2c76aad Compare March 13, 2018 07:40
@datapythonista
Copy link
Member

Thanks a lot, very useful.

@datapythonista datapythonista merged commit d7c6de5 into python-sprints:master Mar 13, 2018
@jorisvandenbossche
Copy link
Contributor

BTW, @dukebody also welcome to do this change in the version in the pandas docs as well

Now that is merged, we should maybe use that one to keep up to date and link to? To not duplicate the changes each time?

@dukebody dukebody deleted the typo-link-pandas-class branch March 18, 2018 13:08
dukebody added a commit to dukebody/pandas that referenced this pull request Mar 18, 2018
@dukebody
Copy link
Contributor Author

@dukebody
Copy link
Contributor Author

Now that is merged, we should maybe use that one to keep up to date and link to? To not duplicate the changes each time?

I agree. Should we delete the guide contents from this repo and replace every page with a link to the development version of the docs, like http://pandas-docs.github.io/pandas-docs-travis/contributing.html.

jorisvandenbossche pushed a commit to pandas-dev/pandas that referenced this pull request Mar 19, 2018
TomAugspurger pushed a commit to pandas-dev/pandas that referenced this pull request Mar 19, 2018
nikoskaragiannakis pushed a commit to nikoskaragiannakis/pandas that referenced this pull request Mar 25, 2018
dworvos pushed a commit to dworvos/pandas that referenced this pull request Apr 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants