Skip to content

DOC: clean up 0.14.1 whatsnew file #7714

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

Conversation

jorisvandenbossche
Copy link
Member

  • removed the sections with no entries
  • removed whitespace
  • moved some entries from API-changes to Enhancements/Big fixes when it was not really a backwards incompatible change or if it was not clear what the relevant change was for users (and for the offsets normalize issue I rewrote it)

Highlights should still be written to include here and in the release.rst

.. _whatsnew_0141.prior_deprecations:
- Previously, the behaviour on resetting the time or not in
``offsets.apply``, ``rollforward`` and ``rollback`` operations differed
between offsets. With the introduction of the ``normalize`` keyword (see
Copy link
Contributor

Choose a reason for hiding this comment

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

well normalize was always their; this was a bug that it was not being passed on (so still API change)

Copy link
Member Author

Choose a reason for hiding this comment

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

"With the introduction of .. " -> "Wit the support of the normalize keyword for all offsets" -> better?

Copy link
Member Author

Choose a reason for hiding this comment

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

I just rewrote this a bit, because how is was previously (I copied the original to enhancements), it was not clear to me what actually changed (and so in which way people's code could be affected/have to be changed)

Copy link
Contributor

Choose a reason for hiding this comment

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

sure...that looks better

@jreback jreback added the Docs label Jul 10, 2014
@jreback jreback added this to the 0.14.1 milestone Jul 10, 2014
@jreback
Copy link
Contributor

jreback commented Jul 10, 2014

something wrong with the rendering here: http://pandas-docs.github.io/pandas-docs-travis/cookbook.html#aliasing-axis-names (it cuts off for some reason)....can you take a look? thxs

@jorisvandenbossche
Copy link
Member Author

I think I fixed it with 9d71aae (just a temp fix, should look more into it as it is probably a bug in the ipython directive)

@jreback
Copy link
Contributor

jreback commented Jul 10, 2014

interesting, so function definitions not handled properly....ok!

@jorisvandenbossche
Copy link
Member Author

Hmm, not as such, eg http://pandas-docs.github.io/pandas-docs-travis/enhancingperf.html#pure-python it renders OK, so it should still be a slightly different issue. But in any case, my hack should let it render OK.

@jorisvandenbossche
Copy link
Member Author

@jreback Should there be som 'highlights'? (also for in the release message)

  • New Documentation section on :ref:Options and Settings <options>
  • select_dtypes function
  • Support for dateutil timezones
  • lots of bug fixes

@jreback
Copy link
Contributor

jreback commented Jul 10, 2014

sure that would be gr8!

@jorisvandenbossche
Copy link
Member Author

Other things you think of?

@jreback
Copy link
Contributor

jreback commented Jul 10, 2014

maybe perf improv
sem
comment parsing (to skip lines)

@jorisvandenbossche
Copy link
Member Author

updated


- :ref:`Enhancements <whatsnew_0141.enhancements>`
- New methods :meth:`~pandas.DataFrame.select_dtypes` to select columns
Copy link
Contributor

Choose a reason for hiding this comment

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

can you add to release.rst as well?

@jorisvandenbossche
Copy link
Member Author

Done.

jorisvandenbossche added a commit that referenced this pull request Jul 10, 2014
@jorisvandenbossche jorisvandenbossche merged commit e2fc854 into pandas-dev:master Jul 10, 2014
@jorisvandenbossche
Copy link
Member Author

Just wait a moment for the doc build to see if it looks OK, then should be good to go!

@jreback
Copy link
Contributor

jreback commented Jul 10, 2014

just ping when u r satisfied

@jorisvandenbossche
Copy link
Member Author

looking good

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

pls upload docs when you can! ping and i'll change the html file (or you can if you u want).

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

seems the offsets (normalize) is in BOTH API and enhancements sections in whatsnew? (its slightly different), did you mean that?

@jorisvandenbossche
Copy link
Member Author

yep, I did that on purpose (because in the enhancement section it is just about the normalize keyword, while in the API it is about the changed behaviour for some offsets). Is it confusing? I can always change it.

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

I would take out the section in Enhancements and leave the API section.

@jorisvandenbossche
Copy link
Member Author

The entry that is now in Enhancements is the original message, but while cleaning up the whatsnew docs, I first moved it from API changes to Enhancements because it said nothing about an API change but just the introduction of a keyword, but when I looked at the connected issue, I saw there was actually an API change, so added another entry in API changes to explain the actual change ..
So I wouldn't delete one of the two (as they are saying different things), but maybe it is less confusing that I merge both in one entry

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

ok 2....its just that on a quick read they look very similar

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

restart the web server to reflect the new docs after you upload

python upload.py from ~/www dir

@jorisvandenbossche
Copy link
Member Author

What do you mean exactly? For the website, or for the docs?

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

I think if you change the docs, need to restart the web server, it should reflect immediately I think

@jorisvandenbossche
Copy link
Member Author

If I tried it in my browser, it was directly changed (just refreshed the page)

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

really? did you push a new commit anyhow?

@jorisvandenbossche
Copy link
Member Author

Looking at the upload.py script, and it seems similar command as in doc/make.py

So I just build the docs locally and then upload them, all with the make.py script (eg the upload_stable option etc). And that seems to work for me (also last time with 0.14 I did not do anything else), as it is directly reflected on the website.

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

it pushes it to the actual server
it will ask for the pw an say it's uploaded
I think it's some kind of setuid script

@jorisvandenbossche
Copy link
Member Author

well, but I suppose doc/make.py does the same thing (it is a similar rsync command to push it to /usr/share/nginx/pandas)

@jorisvandenbossche
Copy link
Member Author

Did you notice a problem with the website/docs?

@jreback
Copy link
Contributor

jreback commented Jul 11, 2014

they look fine, jus not 100% what you changed

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.

2 participants