Added v0.4 what's new document and updated links #2147

Merged
merged 2 commits into from Feb 28, 2014

Projects

None yet

3 participants

@eteq
Member
eteq commented Feb 27, 2014

While writing a what's new section to mention the change in #1826 as suggested by @astrofrog, I realized we do not yet have a What's New page for 0.4 . This adds just such a page and updates the relevant links, as well as including the important note about #1826

@cdeil cdeil commented on an outdated diff Feb 27, 2014
docs/whatsnew/0.4.rst
+.. _whatsnew-0.4:
+
+==========================
+What's New in Astropy 0.4?
+==========================
+
+Overview
+--------
+
+xxx
+
+Documentation/Sphinx extension changes
+--------------------------------------
+
+Starting in v0.4, astropy documentation will now show the full name of functions
+and classes prefixed bythe intended user-facing location. This is in contrast
@cdeil
cdeil Feb 27, 2014 Member

bythe -> by the

@cdeil cdeil commented on an outdated diff Feb 27, 2014
docs/whatsnew/0.4.rst
+
+xxx
+
+Documentation/Sphinx extension changes
+--------------------------------------
+
+Starting in v0.4, astropy documentation will now show the full name of functions
+and classes prefixed bythe intended user-facing location. This is in contrast
+to previous versions, which pointed to the actual implementation module, rather
+than the intended public API location.
+
+This will affect URLs pointing to specific documentation pages. For example,
+this URL points to the v0.3 location of the
+`astropy.cosmology.luminosity_distance` function:
+http://docs.astropy.org/en/v0.3/api/astropy.cosmology.funcs.luminosity_distance.html
+hile the appropriate URL for v0.4 and later is:
@cdeil
cdeil Feb 27, 2014 Member

hile -> while

@cdeil
Member
cdeil commented Feb 27, 2014

How is this travis-ci failure related to the changes in this PR?
https://travis-ci.org/astropy/astropy/jobs/19711489#L1621

@eteq
Member
eteq commented Feb 27, 2014

@cdeil - I think that's not actually related - those look like transient/red herring errors that sometimes appear for no obvious reason. But we'll find out when the tests run for the typo fixes I just put up...

@cdeil
Member
cdeil commented Feb 27, 2014

I think the travis-ci error is another fluke:
https://travis-ci.org/astropy/astropy/jobs/19751514#L1399

👍 to merge.

@eteq
Member
eteq commented Feb 27, 2014

I restarted that one just to be sure - assuming it passes I'll go ahead and merge this.

@astrofrog astrofrog merged commit cedd5fc into astropy:master Feb 28, 2014

1 check passed

default The Travis CI build passed
Details
@astrofrog astrofrog added this to the v0.4.0 milestone Feb 28, 2014
@astrofrog astrofrog added the docs label Feb 28, 2014
@eteq eteq deleted the eteq:add-0.4-whatsnew branch Feb 28, 2014
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment