Skip to content

Commit 29452d1

Browse files
authored
Normalize changelog section markup with release-often
1 parent b2ab814 commit 29452d1

File tree

1 file changed

+16
-26
lines changed

1 file changed

+16
-26
lines changed

docs/changelog.rst

Lines changed: 16 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,9 @@
1-
Changelog
2-
=========
3-
4-
4.2.0
5-
'''''
6-
7-
.. note::
8-
9-
Under development
10-
111

122
- Specify PyJWT[crypto] as a dependency, and dropped the explicit
133
dependency to ``cryptography`` (`Issue #116 <https://github.com/brettcannon/gidgethub/issues/116>`_).
144

155
4.1.0
16-
'''''
6+
======
177

188
- Introduce :mod:`gidgethub.apps`.
199

@@ -25,7 +15,7 @@ Changelog
2515
that can be used to access endpoints that require it.
2616

2717
4.0.0
28-
'''''
18+
=====
2919

3020
- Add :meth:`gidgethub.abc.GitHubAPI.graphql` and related exceptions.
3121
- Add :exc:`gidgethub.BadRequestUnknownError` when something other than JSON is
@@ -42,29 +32,29 @@ Changelog
4232
to the :meth:`gidgethub.abc.GitHubAPI` constructor.
4333

4434
3.3.0
45-
'''''
35+
=====
4636

4737
- Adapt to the new ``httpx`` API to support
4838
`versions >= 0.11.0 <https://github.com/encode/httpx/blob/master/CHANGELOG.md>`_
4939
(thanks `Dave Hirschfeld <https://github.com/dhirschfeld>`_)
5040

5141
3.2.0
52-
'''''
42+
=====
5343

5444
- Fix mypy warnings about the :class:`typing.Dict` and :class:`typing.Mapping`
5545
generic types lacking type parameters.
5646
- Add :mod:`gidgethub.httpx` backend.
5747
- Add a ``py.typed`` file to mark the project as fully typed.
5848

5949
3.1.0
60-
''''''
50+
=====
6151

6252
- :meth:`gidgethub.abc.GitHubAPI.getiter` now works with
6353
`GitHub's search API <https://developer.github.com/v3/search/>`_
6454
(thanks `Pablo Galindo <https://github.com/pablogsal>`_).
6555

6656
3.0.0
67-
'''''
57+
=====
6858

6959
- :meth:`gidgethub.sansio.RateLimit.from_http` returns ``None`` if ratelimit is
7060
not found in the headers.
@@ -79,7 +69,7 @@ Changelog
7969
- gidgethub is now packaged using `flit <https://flit.readthedocs.io/en/latest/>`_.
8070

8171
2.5.0
82-
'''''
72+
=====
8373

8474
- Tighten type hints for parameters that have a default of ``None``
8575
but were not typed as :data:`typing.Optional`.
@@ -96,19 +86,19 @@ Changelog
9686

9787

9888
2.4.1
99-
'''''
89+
=====
10090

10191
- Tighten up protections against caching ineligible responses.
10292

10393

10494
2.4.0
105-
'''''
95+
=====
10696

10797
- Expand :meth:`gidgethub.routing.Router.dispatch`.
10898

10999

110100
2.3.0
111-
'''''
101+
=====
112102

113103
- Add support for ``application/x-www-form-urlencoded`` webhook event payloads.
114104
(This also allows for API calls to return this content type, although GitHub
@@ -123,15 +113,15 @@ Changelog
123113

124114

125115
2.2.0
126-
'''''
116+
=====
127117

128118
- Introduce :mod:`gidgethub.tornado` to support
129119
`Tornado <http://www.tornadoweb.org/>`_ (thanks to
130120
Matthias Bussonnier and A. Jesse Jiryu Davis for the PR reviews).
131121

132122

133123
2.1.0
134-
'''''
124+
=====
135125

136126
- The default value for the *data* argument of :meth:`gidgethub.abc.GitHubAPI.put`
137127
was changed from ``""`` to ``b""``.
@@ -140,7 +130,7 @@ Changelog
140130

141131

142132
2.0.0
143-
'''''
133+
=====
144134

145135
- Renamed ``gidgethub.abc.GitHubAPI._sleep()`` to
146136
:meth:`~gidgethub.abc.GitHubAPI.sleep()` to make the method public.
@@ -153,7 +143,7 @@ Changelog
153143

154144

155145
1.2.0
156-
'''''
146+
=====
157147

158148
- :meth:`gidgethub.sansio.Event.from_http` raises a :exc:`gidgethub.BadRequest` of ``415``
159149
instead of ``400`` when a content-type other than ``application/json``
@@ -166,12 +156,12 @@ Changelog
166156

167157

168158
1.1.0
169-
'''''
159+
=====
170160

171161
- Introduced ``gidgethub.treq`` (thanks to Cory Benfield).
172162

173163

174164
1.0.0
175-
'''''
165+
=====
176166

177167
Initial release.

0 commit comments

Comments
 (0)