Skip to content

Conversation

@vshlapakov
Copy link
Contributor

Revive NEWS file based on GIT history.

Review, please.

@codecov-io
Copy link

codecov-io commented Dec 6, 2016

Current coverage is 93.80% (diff: 100%)

Merging #37 into master will not change coverage

@@             master        #37   diff @@
==========================================
  Files            14         14          
  Lines          1178       1178          
  Methods           0          0          
  Messages          0          0          
  Branches          0          0          
==========================================
  Hits           1105       1105          
  Misses           73         73          
  Partials          0          0          

Powered by Codecov. Last update 083ab54...b4a392b

NEWS Outdated

Version 1.9.0
-------------
(release on Nov 2nd, 2016)
Copy link
Contributor

Choose a reason for hiding this comment

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

why not to include date in the header, seems to be common practice

https://github.com/scrapy/scrapy/blob/master/docs/news.rst
https://github.com/kennethreitz/requests/blob/master/HISTORY.rst

I like requests approach <version> (<date>) the most - short and clean

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Sounds good, will do!

Copy link
Contributor

@redapple redapple Dec 7, 2016

Choose a reason for hiding this comment

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

Note that starting with a digit seems to cause trouble with generated link (for Sphinx at least)
e.g for "2.12.3 (2016-12-01)", the link is
http://docs.python-requests.org/en/master/community/updates/#id1

I "fixed" it in Scrapy by prepending "Scrapy " (scrapy/scrapy#2294)

Copy link
Contributor Author

@vshlapakov vshlapakov Dec 7, 2016

Choose a reason for hiding this comment

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

Thanks for the hint @redapple!
@chekunkov Maybe prepend with just v like v1.9.0 (2016-11-02)?

Hmm, maybe not necessary, I've done some tests and it works fine at least with Github:
https://github.com/scrapinghub/python-scrapinghub/blob/temp-test-links/NEWS.rst#180-2016-07-29

Copy link
Contributor

Choose a reason for hiding this comment

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

that's strange @redapple we'll change the headers later if starting digit will stand in our way :)

NEWS Outdated
- all tests are improved and rewritten with py.test
- hubstorage tests use vcrpy cassettes, work faster and don't require any external services to run

python-hubstorage is going to be considered deprecated,
Copy link
Contributor

Choose a reason for hiding this comment

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

can we add a link to python-hubstorage?

@vshlapakov vshlapakov changed the title Revive NEWS file based on Revive NEWS file based on GIT history Dec 7, 2016
@vshlapakov vshlapakov changed the title Revive NEWS file based on GIT history Revive NEWS file from GIT history Dec 7, 2016
@chekunkov chekunkov merged commit e690892 into master Dec 7, 2016
@chekunkov chekunkov deleted the revive-news branch December 7, 2016 13:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants