8000 Fix proselint issues · marknet15/github3.py@f9ce2bc · GitHub
[go: up one dir, main page]

Skip to content

Commit f9ce2bc

Browse files
committed
Fix proselint issues
This commit fixes proselint issues to pass the py39 test suite. It expicitly ignores contents of docs/source/examples/octocat.rst, as the file contains a lot of ascii graphics that drives the linter crazy.
1 parent 8c4b684 commit f9ce2bc

File tree

4 files changed

+5
-5
lines changed

4 files changed

+5
-5
lines changed

docs/bin/lint

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
#!/bin/sh
2-
output="$(find docs/source -name '*.rst' | xargs proselint)"
2+
output="$(find docs/source -name '*.rst' | grep -v docs/source/examples/octocat.rst | xargs proselint)"
33
exit_code=$?
44

55
if echo "$output" | grep -qve 'typography' ; then

docs/source/contributing/testing.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -229,7 +229,7 @@ started when you write
229229
.. code:: python
230230
231231
with self.recorder.use_cassette(cassette_name):
232-
# ...
232+
#
233233
234234
Everything that talks to GitHub should be written inside of the context
235235
created by the context manager there. No requests to GitHub should be made

docs/source/examples/gist.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ Creating an anonymous gist
5555
print(gist.html_url)
5656

5757
In the above examples ``'spam.txt'`` is the file name. GitHub will autodetect
58-
file type based on extension provided. ``'What... is the air-speed velocity of
58+
file type based on extension provided. ``'What is the air-speed velocity of
5959
an unladen swallow?'`` is the file's content or body. ``'Answer this to cross
6060
the bridge'`` is the gist's description. While required by github3.py, it is
6161
allowed to be empty, e.g., ``''`` is accepted by GitHub.

docs/source/release-notes/1.0.0.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -453,7 +453,7 @@ New Features
453453

454454
- Add ``Organization#all_events``.
455455

456-
- Add ``Tag.tagger_as_User`` which attempts to return the tagger as as User.
456+
- Add ``Tag.tagger_as_User`` which attempts to return the tagger as User.
457457

458458
- Add ``Repo.statuses`` and a corresponding ``repo.status.CombinedStatus`` to
459459

@@ -539,7 +539,7 @@ Bugs Fixed
539539
so we accidentally left out our actual hard dependencies.
540540

541541
- The ``context`` parameter to ``Repository#create_status`` now properly
542-
defaults to ``"default"``.
542+
defaults to ``default``.
543543

544544
- Fix AttributeError when ``IssueEvent`` has assignee.
545545

0 commit comments

Comments
 (0)
0