Skip to content

Commit

Permalink
Clean changelog. Bump to version: 3.5.0
Browse files Browse the repository at this point in the history
  • Loading branch information
@voussoir
voussoir committed May 10, 2016
1 parent eb7ac28 commit 0c88697
Showing 1 changed file with 14 additions and 19 deletions.
33 changes: 14 additions & 19 deletions CHANGES.rst
View file
Expand Up @@ -12,36 +12,31 @@ upstream changes.
3.5.0 (2016-05-10)
------------------
* **[BUGFIX]** Prevent built-in method `dir` from causing RedditContentObjects
to perform web requests in Python 2.
* **[FEATURE]** Added support for thread locking. See
:meth:`~praw.objects.Submission.lock` and
:meth:`~praw.objects.Submission.unlock`.
* **[FEATURE]** Added support for comment stickying. Try
:meth:`~praw.objects.Comment.distinguish` with new parameter `sticky`.
* **[FEATURE]** Methods :meth:`~praw.__init__.ReportMixin.hide` and
* **[BUGFIX]** Prevent built-in method `dir` from causing RedditContentObjects
to perform web requests in Python 2.
* **[FEATURE]** Added support for thread locking. See
:meth:`~praw.objects.Submission.lock` and
:meth:`~praw.objects.Submission.unlock`.
* **[FEATURE]** Added support for comment stickying. Try
:meth:`~praw.objects.Comment.distinguish` with new parameter `sticky`.
* **[FEATURE]** Methods :meth:`~praw.__init__.ReportMixin.hide` and
:meth:`~praw.__init__.UnauthenticatedReddit.get_info` now support long lists
of fullnames. They will divide the list up into small, requestable chunks
automatically.

3.4.0 (2016-02-21)
------------------

**Added**

* Added support for modmail muting. See
* **[CHANGE]** Image uploads support PNG images as small as 67 bytes.
* **[FEATURE]** Added support for modmail muting. See
:meth:`~praw.objects.Subreddit.add_mute`,
:meth:`~praw.__init__.ModOnlyMixin.get_muted`,
:meth:`~praw.objects.Subreddit.remove_mute`,
:meth:`~praw.objects.Message.mute_modmail_author`, and
:meth:`~praw.objects.Message.unmute_modmail_author`.
* :meth:`~praw.__init__.UnauthenticatedReddit.default_subreddits`.
* Support for ``*`` OAuth scopes.
* :meth:`~praw.__init__.UnauthenticatedReddit.get_traffic`

**Changed**

* Image uploads support PNG images as small as 67 bytes.
* **[FEATURE]** Added
:meth:`~praw.__init__.UnauthenticatedReddit.default_subreddits`.
* **[FEATURE]** Added support for ``*`` OAuth scopes.
* **[FEATURE]** Added :meth:`~praw.__init__.UnauthenticatedReddit.get_traffic`

PRAW 3.3.0
----------
Expand Down

5 comments on commit 0c88697

@bboe
Copy link
Member

@bboe bboe commented on 0c88697 May 10, 2016

Choose a reason for hiding this comment

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

Thanks for updating the changelog and releasing. What do you think about using this changelog format?

http://keepachangelog.com/

I think it's a little easier to work with and conveys the same or more information.

@voussoir
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I do like the inclusion of the date next to the version number, but other than that I feel like I don't get as much information at a glance as I do with the existing format. The current version really emphasizes "this release consists mostly of [BUGFIX]", and the vertical lines from the quote-block elements help distinguish releases. In the new version, the bullets start to blend together a little bit and I have to check what header something falls under.

Sorry for reverting the formatting on you, but the inconsistency confused me. If we experiment with a new format I think we should rewrite the changelog once we decide, so everything looks the same.

@bboe
Copy link
Member

@bboe bboe commented on 0c88697 May 10, 2016 •
edited

Choose a reason for hiding this comment

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

I agree the at-a-glance view is not as concise. However, for the ease of pointing people to http://keepachangelog.com/ I would like to follow that document going forward. While it would be nice to update all past changelog entries, I do not see that as a requirement to impose the new format going forward.

With that said we could only use the new format with everything >= 4.0.

@voussoir
Copy link
Contributor Author

@voussoir voussoir commented on 0c88697 May 10, 2016 •
edited

Choose a reason for hiding this comment

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

Starting the new format in PRAW4+ sounds like a fair compromise. Are there any design elements you would be comfortable adding, to improve readability without deviating too far from the keepachangelog structure? Even small things like the blockquote line really help visually compartmentalize each release. If we both feel that the kacl structure is less immediately clear than it could be, I think that's a good sign that some customization is worthwhile.

@bboe
Copy link
Member

@bboe bboe commented on 0c88697 May 12, 2016

Choose a reason for hiding this comment

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

If there is anything you'd like to add, it would probably be nice adding it to contributing.md.

Please sign in to comment.