Skip to content

DOC: merge FAQ / Caveats & Gotchas #9809

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
jreback opened this issue Apr 4, 2015 · 5 comments
Closed

DOC: merge FAQ / Caveats & Gotchas #9809

jreback opened this issue Apr 4, 2015 · 5 comments
Labels
Milestone

Comments

@jreback
Copy link
Contributor

jreback commented Apr 4, 2015

xref #9802

  • I think making it FAQ would most appropriate
  • want to think about the orderings
  • need a release note to indicate that these have been merged
@jreback jreback added this to the 0.16.1 milestone Apr 4, 2015
@shoyer
Copy link
Member

shoyer commented Apr 5, 2015

Agreed, would be nice to consolidate these.

Looking over these pages again, several of the FAQ sections ("Migrating from scikits.timeseries" and "Visualizing Data in Qt applications") look very outdated and could probably be removed.

@jreback
Copy link
Contributor Author

jreback commented Apr 5, 2015

the Visualizing Data is marked as deprecated already (but its only docs here, can prob just take it out)

@jreback
Copy link
Contributor Author

jreback commented Apr 5, 2015

should also think about the 3 indexing mentions in the Caveats and Gotchas and whether these should really be in one of the indexing sections.

- Integer indexing -> move to advanced.rst
- Label-based slicing conventions -> move to indexing.rst
  - Non-monotonic indexes require exact matches
  - Endpoints are inclusive
- Miscellaneous indexing gotchas
  - Reindex versus ix gotchas (move to advanced.rst with the Integer Indexing from above)
  - Reindex potentially changes underlying Series dtype (needs a note in reindex section / indexing)

@jorisvandenbossche
Copy link
Member

Also agree we can merge these sections.
Although FAQ is maybe a good name, I also like the 'gotchas' wording, as it really are some typical 'gotchas' (frequently asked questions sounds more oriented to newcomers to me with questions about the project, while the content is not quite like that).

I think we should also move some parts to the actual documentation on that issue, eg the indexing questions that @jreback noted, but I think also the html parsing issues

@jreback jreback modified the milestones: 0.16.1, 0.17.0 Apr 28, 2015
@mbirdi
Copy link

mbirdi commented Apr 30, 2015

In the earlier part of this thread, it mentions parts of the documentation which "look very outdated and could probably be removed."

I don't know if removing parts of the documentation is a novice level task. I am a novice when it comes to python and pandas, and when I read the documentation of a python library, I generally believe it all. I have not really thought to myself, this is can be removed when I have read the docs. I think the difficulty level of this task should be raised to intermediate, since you need to know how things have changed in the different pandas versions over time.

@jreback jreback modified the milestones: Next Major Release, 0.17.0 Aug 15, 2015
@jreback jreback modified the milestones: 0.20.0, Next Major Release Jan 25, 2017
AnkurDedania pushed a commit to AnkurDedania/pandas that referenced this issue Mar 21, 2017
Rebase and clean-up of pandas-dev#13768
closes pandas-dev#9809

Author: Joris Van den Bossche <[email protected]>
Author: sinhrks <[email protected]>

Closes pandas-dev#15222 from jorisvandenbossche/pr/13768 and squashes the following commits:

7abb65b [Joris Van den Bossche] Make 'indexing may change dtype' more general
53a6970 [Joris Van den Bossche] Move HTML libraries gotchas to html io docs
7185dd4 [Joris Van den Bossche] Keep original gotchas label for references
c9e41cc [Joris Van den Bossche] Redo updates after ix deprecation
ab7fdf0 [Joris Van den Bossche] restore file name
f5e0af0 [sinhrks] DOC: Merge FAQ and gotcha
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
4 participants