DOC/CLN: remove gh links and use the new issue format for whatsnew
State: closed

closes #3182.


Labels:

Comments:
@jreback can i link to pandas docs generically (that is, ignoring whether it's the dev or stable docs) _outside_ of sphinx?

hm nvm that doesn't really make any sense

i think rls notes should point to stable docs, agreed?

yes (like v0.11.1.txt like)....but all in 1 file; and its still an rst so top-level release notes file can just be a link

that's how it is in this pr if i understand u correctly

@cpcloud since all pull requests can be issues (and reached by issue link) is there a reason to separate PR vs. issue?

maybe one less level of indirection but there are so few that it doesn't really matter either way, especially for those old releases, going forward though, should just do issues

@jreback any problems here? would like 2 merge this... how can i loudly notify people not to use the

``` rst
.. _GH1234: http://www.github.com/pydata/pandas/issues/1234
```

syntax anymore...the whole point would be that after this PR u don't have to do that...

I think it will be pretty clean given that entire section of RELEASE.rst
will be gone. [for example, I figured out what I was supposed to do because
it was the same way everywhere else in the docs]

On Wed, Jun 19, 2013 at 10:52 PM, Phillip Cloud notifications@github.comwrote:

> @jreback https://github.com/jreback any problems here? how can i loudly
> notify people not to use the
> 
> .. _GH1234: http://www.github.com/pydata/pandas/issues/1234
> 
> syntax anymore...the whole point would be that after this PR u don't have
> to do that...
> 
> —
> Reply to this email directly or view it on GitHubhttps://github.com/pydata/pandas/pull/3961#issuecomment-19728131
> .

yep i c what u mean i just want to elicit the minimum number of wtfs

@cpcloud at first I thought just writing `GH1391_` would create an appropriate link, so it works both ways.

The point tho is to not write the old way, going forward since it adds clutter and unnecessary repetition.. It will still work and until people get used to it I guess I can look over documentation more closely.

can you add a new section on the wiki 

maybe testing/docs....... on how to do issues/pr?

Already there :) 

@wesm, @y-p ok with this?

an IS prefix makes less sense then GH to me, and I also don't see the need for having an 
IS/PR distinction.
Still holding out for @cpcloud to embrace a "minimal required change" doctorine... :)

Since the pair of you are by far the most active commiters right now, and will be impacted 
most by these changes - If this is convenient for you, no objections here.

Would moving the release notes break old links, on the docs site especially?

@y-p the IS/PR distinction was not something put in by me and i agree with you wholeheartedly, i removed them all...i only mention issues in the wiki and i've removed the pull request role from extlinks.

let's merge this soon.....

though prob have to fix things up in subsequent...

also @y-p has good point.....aside from the release notes link in the whatsnews...what about links on pandas website?

can you put a soft-link in pandas/RELEASE.rst to pandas/doc/source/release.rst somehow?

not sure what you mean by soft link...RELEASE.rst has no knowledge of any of the other docs. can link to the dev and/or stable release notes on the website...right now it looks like this

``` rst
=============
Release Notes
=============

The list of changes to pandas between each release can be found `here
<http://pandas.pydata.org/pandas-docs/stable/release.html>`. For full details,
see the commit logs at http://github.com/pydata/pandas.
```

where is that built?

it's not...RELEASE.rst is only for GH as i understand it

```
 <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
 on GitHub for a complete list.
```

you should change to new location (these are in all of the v0.11.1....at the end)

ah ok thanks will do

then don't need a link

also contributing,manifest need changing

```
./CONTRIBUTING.md:
   74 :   - RELEASE.rst and doc/source/vx.y.z.txt contain an on-going changelog for each
./MANIFEST:
    5 : RELEASE.rst
./MANIFEST.in:
    3 : include RELEASE.rst
./doc/build/html/whatsnew.html:
  766 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 1304 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 1610 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 2272 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 2510 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 2613 : <p>See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 2663 : necessary. See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release notes</a> or issue tracker
 2960 : even though they do constitute a change in behavior. See the <a class="reference external" href="https://github.com/pydata/pandas/blob/master/RELEASE.rst">full release
./doc/source/v0.10.0.txt:
  354 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.10.1.txt:
  210 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.11.0.txt:
  324 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.11.1.txt:
  391 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.7.3.txt:
   10 : notes <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue
./doc/source/v0.8.0.txt:
   14 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.9.0.txt:
   92 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./doc/source/v0.9.1.txt:
  140 : <https://github.com/pydata/pandas/blob/master/RELEASE.rst>`__ or issue tracker
./setup.py:
  192 : ISRELEASED = False
  197 : if not ISRELEASED:
  464 : # if not ISRELEASED:
```

thanks i'm assuming u did `grin RELEASE`

manifest can probably stay the same. RELEASE.rst will stil be there

yes..ok

my grin is now showing 

```
./MANIFEST:
    5 : RELEASE.rst
./MANIFEST.in:
    3 : include RELEASE.rst
./pandas.egg-info/SOURCES.txt:
    4 : RELEASE.rst
./setup.py:
  192 : ISRELEASED = False
  197 : if not ISRELEASED:
  464 : # if not ISRELEASED:
```

TIL how useful vim's `args` and `argdo` are.