diff options
| author | Charles Harris <charlesr.harris@gmail.com> | 2018-01-18 10:37:12 -0700 |
|---|---|---|
| committer | Charles Harris <charlesr.harris@gmail.com> | 2018-01-18 10:37:12 -0700 |
| commit | 2dfa9e88864f17f7d097e413fa74561feb8f6515 (patch) | |
| tree | da5fcba60f2f477ca9cba6ae97454a489150a393 /tools | |
| parent | fa6f879daff043201d1be2beaee537ca096e1f5d (diff) | |
| download | python-numpy-2dfa9e88864f17f7d097e413fa74561feb8f6515.tar.gz python-numpy-2dfa9e88864f17f7d097e413fa74561feb8f6515.tar.bz2 python-numpy-2dfa9e88864f17f7d097e413fa74561feb8f6515.zip | |
MAINT: Update changlog.py docstring.
[skip ci]
Diffstat (limited to 'tools')
| -rwxr-xr-x | tools/changelog.py | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/tools/changelog.py b/tools/changelog.py index 05ea8cb36..84e046c5f 100755 --- a/tools/changelog.py +++ b/tools/changelog.py @@ -1,10 +1,10 @@ #!/usr/bin/env python # -*- encoding:utf-8 -*- """ -Script to generate contribor and pull request lists +Script to generate contributor and pull request lists This script generates contributor and pull request lists for release -announcements using Github v3 protocol. Use requires an authentication token in +changelogs using Github v3 protocol. Use requires an authentication token in order to have sufficient bandwidth, you can get one following the directions at `<https://help.github.com/articles/creating-an-access-token-for-command-line-use/>_ Don't add any scope, as the default is read access to public information. The @@ -28,9 +28,9 @@ Some code was copied from scipy `tools/gh_list.py` and `tools/authors.py`. Examples -------- -From the bash command line with $GITHUB token. +From the bash command line with $GITHUB token:: - $ ./tools/announce $GITHUB v1.11.0..v1.11.1 > announce.rst + $ ./tools/announce $GITHUB v1.13.0..v1.14.0 > 1.14.0-changelog.rst """ from __future__ import print_function, division |