search

python-sprints / python-sprints.github.io

Python Sprints website
https://python-sprints.github.io/
12 stars 55 forks source link

Only use ~ in class ref to hide prefix #78

Closed dukebody closed 6 years ago

dukebody commented 6 years ago

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

datapythonista commented 6 years ago

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

TomAugspurger commented 6 years ago

~ 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 commented 6 years ago

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

I will modify the PR to say this.

datapythonista commented 6 years ago

Thanks a lot, very useful.

jorisvandenbossche commented 6 years ago

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 commented 6 years ago

@jorisvandenbossche done: https://github.com/pandas-dev/pandas/pull/20402

dukebody commented 6 years ago

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.