Skip to content

Commit 999c503

Browse files
LilSpazJoekpgithub-actions[bot]
authored andcommitted
Update pre-commit hooks
1 parent 9221cbe commit 999c503

File tree

149 files changed

+686
-474
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

149 files changed

+686
-474
lines changed

.github/CONTRIBUTING.rst

Lines changed: 25 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,17 @@
1-
Guidelines for Contributing
2-
===========================
1+
#############################
2+
Guidelines for Contributing
3+
#############################
34

4-
Code of Conduct
5-
---------------
5+
*****************
6+
Code of Conduct
7+
*****************
68

79
This project is released with a `Contributor Code of Conduct`_. By participating in this
810
project you agree to abide by its terms.
911

10-
Creating an Issue
11-
-----------------
12+
*******************
13+
Creating an Issue
14+
*******************
1215

1316
1. Please do not create issues for questions you have. The appropriate location for such
1417
questions is `r/redditdev`_ or via Slack_.
@@ -17,15 +20,17 @@ Creating an Issue
1720
3. Please use GitHub's issue search feature to look for already reported issues before
1821
reporting your own.
1922

20-
Responding to Issues
21-
--------------------
23+
**********************
24+
Responding to Issues
25+
**********************
2226

2327
One of the simplest ways to help with Async PRAW is by answering others questions. When
2428
responding, always be positive. While something may be obvious to you, it likely is not
2529
to the person asking the question.
2630

27-
Creating Pull Requests
28-
----------------------
31+
************************
32+
Creating Pull Requests
33+
************************
2934

3035
1. If you are fixing an already filed issue, please indicate your intentions by
3136
commenting on the issue. This act will hopefully minimize any duplicate work.
@@ -58,15 +63,17 @@ Creating Pull Requests
5863
9. Feel free to check on the status of your pull request periodically by adding a
5964
comment.
6065

61-
Becoming a Team Member
62-
----------------------
66+
************************
67+
Becoming a Team Member
68+
************************
6369

6470
The PRAW team is always interested in expanding Async PRAW's active team member base
6571
with proven contributors. If you are interested, please let us know. In general, we
6672
would like to see you push a number of contributions before we add you on.
6773

68-
Style Recommendations
69-
---------------------
74+
***********************
75+
Style Recommendations
76+
***********************
7077

7178
To keep Async PRAW's source consistent, all contribution code must pass the
7279
``pre_push.py`` script. GitHub Actions will enforce the passing of the automated tests,
@@ -75,7 +82,7 @@ ensure consistency with much of PEP8 and PEP257 there are a few things that it d
7582
enforce. Please look over the following list:
7683

7784
Method Order within a Class
78-
~~~~~~~~~~~~~~~~~~~~~~~~~~~
85+
===========================
7986

8087
- Group method names by type and order the groups like so:
8188

@@ -113,8 +120,9 @@ Method Order within a Class
113120
def instance_method(self):
114121
pass
115122
116-
See Also
117-
--------
123+
**********
124+
See Also
125+
**********
118126

119127
Please also read `Contributing to Async PRAW`_.
120128

.pre-commit-config.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,12 +22,12 @@ repos:
2222
- id: ruff
2323
args: [ --exit-non-zero-on-fix, --fix ]
2424
files: ^(praw/.*.py)$
25-
rev: v0.13.3
25+
rev: v0.14.7
2626

2727
- repo: https://github.com/LilSpazJoekp/docstrfmt
2828
hooks:
2929
- id: docstrfmt
30-
rev: v1.11.1
30+
rev: v2.0.0
3131

3232
- repo: https://github.com/MarcoGorelli/auto-walrus
3333
hooks:

AUTHORS.rst

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
Author/Maintainer
2-
=================
1+
###################
2+
Author/Maintainer
3+
###################
34

45
- Joel Payne <[email protected]> `@LilSpazJoekp <https://github.com/lilspazjoekp>`_
56

6-
Documentation Contributors
7-
==========================
7+
############################
8+
Documentation Contributors
9+
############################
810

911
- Dale Cudmore <[email protected]> `@DCuddies <https://github.com/DCuddies>`_
1012
- Zhifu Ge <[email protected]> `@zhifuge <https://github.com/zhifuge>`_
@@ -34,18 +36,21 @@ Documentation Contributors
3436
- Andrew Chen Wang `@Andrew-Chen-Wang <https://github.com/Andrew-Chen-Wang>`_
3537
- Add "Name <email (optional)> and github profile link" above this line.
3638

37-
PRAW Author
38-
===========
39+
#############
40+
PRAW Author
41+
#############
3942

4043
- Bryce Boe <[email protected]> `@bboe <https://github.com/bboe>`_
4144

42-
Logo Creator
43-
============
45+
##############
46+
Logo Creator
47+
##############
4448

4549
- kungming2 `@kungming2 <https://github.com/kungming2>`_
4650

47-
Source Contributors
48-
===================
51+
#####################
52+
Source Contributors
53+
#####################
4954

5055
- Ethan Dalool <[email protected]> `@voussoir <https://github.com/voussoir>`_
5156
- William McKinnerney <[email protected]> `@williammck <https://github.com/williammck>`_

CHANGES.rst

Lines changed: 48 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
1-
Change Log
2-
==========
1+
############
2+
Change Log
3+
############
34

45
Async PRAW follows `semantic versioning <https://semver.org/>`_.
56

6-
Unreleased
7-
----------
7+
************
8+
Unreleased
9+
************
810

911
**Added**
1012

@@ -88,15 +90,17 @@ Unreleased
8890
- Remove ``SubredditMessage.mute`` and ``SubredditMessage.unmute`` methods.
8991
- Remove ``InboxableMixin.unblock_subreddit`` method.
9092

91-
7.8.1 (2024/12/21)
92-
------------------
93+
********************
94+
7.8.1 (2024/12/21)
95+
********************
9396

9497
**Changed**
9598

9699
- Bump asyncprawcore minimum version.
97100

98-
7.8.0 (2024/10/20)
99-
------------------
101+
********************
102+
7.8.0 (2024/10/20)
103+
********************
100104

101105
**Added**
102106

@@ -141,8 +145,9 @@ Unreleased
141145

142146
- XML parsing error when media uploads fail.
143147

144-
7.7.1 (2023/07/11)
145-
------------------
148+
********************
149+
7.7.1 (2023/07/11)
150+
********************
146151

147152
**Changed**
148153

@@ -152,8 +157,9 @@ Unreleased
152157

153158
- An issue with replying to a modmail conversation results in a error.
154159

155-
7.7.0 (2023/02/25)
156-
------------------
160+
********************
161+
7.7.0 (2023/02/25)
162+
********************
157163

158164
**Added**
159165

@@ -166,8 +172,9 @@ Unreleased
166172
- An issue when uploading media during the submission of a new media post.
167173
- Removal reasons are now returned in the same order as they appear on Reddit.
168174

169-
7.6.1 (2022/11/28)
170-
------------------
175+
********************
176+
7.6.1 (2022/11/28)
177+
********************
171178

172179
**Changed**
173180

@@ -179,8 +186,9 @@ Unreleased
179186
- An issue where :class:`.ModmailConversation`'s ``messages`` attribute would only
180187
contain the latest message.
181188

182-
7.6.0 (2022/10/23)
183-
------------------
189+
********************
190+
7.6.0 (2022/10/23)
191+
********************
184192

185193
**Added**
186194

@@ -227,8 +235,9 @@ Unreleased
227235
alphabetically, and prevent breaking changes when adding new arguments to existing
228236
methods.
229237

230-
7.5.0 (2021/11/13)
231-
------------------
238+
********************
239+
7.5.0 (2021/11/13)
240+
********************
232241

233242
**Added**
234243

@@ -259,8 +268,9 @@ Unreleased
259268
- An import error when using Async PRAW in environments where ``libsqlite3-dev`` is
260269
needed to utilize ``aiosqlite`` package which depends on the ``sqlite3`` builtin.
261270

262-
7.4.0 (2021/07/30)
263-
------------------
271+
********************
272+
7.4.0 (2021/07/30)
273+
********************
264274

265275
**Added**
266276

@@ -284,8 +294,9 @@ Unreleased
284294

285295
- :class:`.Reddit` keyword argument ``token_manager``.
286296

287-
7.3.1 (2021/07/06)
288-
------------------
297+
********************
298+
7.3.1 (2021/07/06)
299+
********************
289300

290301
**Changed**
291302

@@ -298,8 +309,9 @@ Unreleased
298309
- Fixed an issue where some :class:`.RedditBase` objects would be sent in a request as
299310
``"None"``.
300311

301-
7.3.0 (2021/06/18)
302-
------------------
312+
********************
313+
7.3.0 (2021/06/18)
314+
********************
303315

304316
**Added**
305317

@@ -338,8 +350,9 @@ Unreleased
338350
- Fixed bug where :meth:`~.FullnameMixin.fullname` sometimes returned the wrong
339351
fullname.
340352

341-
7.2.0 (2021/02/25)
342-
------------------
353+
********************
354+
7.2.0 (2021/02/25)
355+
********************
343356

344357
**Added**
345358

@@ -360,8 +373,9 @@ Unreleased
360373
switch forward to the Async PRAW 8 behavior set ``praw8_raise_exception_on_me=True``
361374
in your ``asyncpraw.Reddit(...)`` call.
362375

363-
7.1.1 (2021/02/11)
364-
------------------
376+
********************
377+
7.1.1 (2021/02/11)
378+
********************
365379

366380
**Added**
367381

@@ -405,13 +419,15 @@ Unreleased
405419
- An issue where streams could get stuck on a deleted item and never pull new items.
406420
- Fix subreddit style asset uploading.
407421

408-
7.1.0 (2020/07/16)
409-
------------------
422+
********************
423+
7.1.0 (2020/07/16)
424+
********************
410425

411426
- First official Async PRAW release!
412427

413-
7.1.0.pre1 (2020/07/16)
414-
-----------------------
428+
*************************
429+
7.1.0.pre1 (2020/07/16)
430+
*************************
415431

416432
- Initial Async PRAW pre-release.
417433

0 commit comments

Comments
 (0)