Skip to content

Commit d065f91

Browse files
committed
Added pre-commit and fixed spaces/end-of-file
1 parent 0f26d5e commit d065f91

File tree

445 files changed

+501
-489
lines changed

Some content is hidden

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

445 files changed

+501
-489
lines changed

.github/pull_request_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
Before opening a new issue, please [search][] for a previously filed
22
issue to ensure you're not creating a duplicate.
33

4-
**Note** Bug reports without the following will receive requests for these
4+
**Note** Bug reports without the following will receive requests for these
55
details to be provided.
66

77
## Version Information

.github/workflows/build.yml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,4 +37,3 @@ jobs:
3737
TOXENV: ${{ matrix.PYTHON.TOXENV }}
3838
GH_RECORD_MODE: "none"
3939
continue-on-error: ${{ matrix.PYTHON.ALLOW_FAILURE }}
40-

.gitignore

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ tests/id_rsa
2424
.pytest_cache/
2525
t.py
2626
*.pem
27-
/.python-version
27+
/.python-version

.pre-commit-config.yaml

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
repos:
2+
- repo: https://github.com/pre-commit/pre-commit-hooks
3+
rev: v4.0.1
4+
hooks:
5+
- id: check-added-large-files
6+
- id: check-toml
7+
types: [toml]
8+
- id: check-yaml
9+
types: [yaml]
10+
- id: end-of-file-fixer
11+
types: [text]
12+
stages: [commit, push, manual]
13+
- id: trailing-whitespace
14+
types: [text]
15+
stages: [commit, push, manual]

CONTRIBUTING.rst

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,53 +5,53 @@ Guidelines for Contributing to github3.py
55

66
#. Please do **not** use the issue tracker for questions.
77

8-
#. Please use GitHub's search feature to look for already reported issues
8+
#. Please use GitHub's search feature to look for already reported issues
99
before reporting your own.
1010

11-
#. Regardless of the magnitude your pull request (a couple lines to a couple
12-
hundred lines), please add your name to the AUTHORS.rst_ file under the
11+
#. Regardless of the magnitude your pull request (a couple lines to a couple
12+
hundred lines), please add your name to the AUTHORS.rst_ file under the
1313
heading Contributors.
1414

1515
#. There is a label for issues that should be minor and should be a good way
16-
to become acquainted with the project. The easy_ label is the over-arching
17-
way to determine which issues you can dig into without a great deal of
18-
prior knowledge. Most of these issues have a `Pair with Ian`_ label which
19-
means that if you would like, I (@sigmavirus24) will happily pair program
16+
to become acquainted with the project. The easy_ label is the over-arching
17+
way to determine which issues you can dig into without a great deal of
18+
prior knowledge. Most of these issues have a `Pair with Ian`_ label which
19+
means that if you would like, I (@sigmavirus24) will happily pair program
2020
with you to solve the issue.
2121

22-
#. If you're fixing a bug, please write a regression test. All the tests are
22+
#. If you're fixing a bug, please write a regression test. All the tests are
2323
structured like so::
2424

2525
tests/
2626
- test_<module_name>.py
2727
+ Test<ClassName>
2828
- def test_function_or_attribute
2929

30-
Please do not add your regression test to an existing test, but create a
31-
new one. You can use the form ``test_issue_<number>``. In a docstring add
32-
the link and a short description of the regression issue. For example, if
33-
you found a bug in the class ``Issue``, write your test in the file
34-
``test_issues.py`` in the class ``TestIssue``. You can place the new test
30+
Please do not add your regression test to an existing test, but create a
31+
new one. You can use the form ``test_issue_<number>``. In a docstring add
32+
the link and a short description of the regression issue. For example, if
33+
you found a bug in the class ``Issue``, write your test in the file
34+
``test_issues.py`` in the class ``TestIssue``. You can place the new test
3535
in any order, e.g., below all the existing tests, near a related one, &c.
3636

37-
#. If you're adding a new section of the API that does not already exist,
37+
#. If you're adding a new section of the API that does not already exist,
3838
please also add tests to the test suite.
3939

40-
#. If you're adding additional functionality beyond what the API covers,
41-
please open an issue request first and of course add tests to cover the
40+
#. If you're adding additional functionality beyond what the API covers,
41+
please open an issue request first and of course add tests to cover the
4242
functionality in the event it is accepted.
4343

44-
Also, please be certain to add docstrings_ to these functions. Follow the
44+
Also, please be certain to add docstrings_ to these functions. Follow the
4545
example of other docstrings.
4646

4747
#. In case you haven't caught on, for anything you add, write tests.
4848

49-
#. Be cordial_. Seriously, anyone who isn't cordial will be sent packing,
50-
regardless of the value of their contributions. I will not tolerate some
49+
#. Be cordial_. Seriously, anyone who isn't cordial will be sent packing,
50+
regardless of the value of their contributions. I will not tolerate some
5151
contributors creating a hostile environment for others.
5252

53-
#. Rebase your fork/branch if needed and possible before submitting a pull
54-
request. This makes my life easier. If you honestly have no idea what I'm
53+
#. Rebase your fork/branch if needed and possible before submitting a pull
54+
request. This makes my life easier. If you honestly have no idea what I'm
5555
talking about, don't worry, I'll take care of it.
5656

5757
#. Please follow pep-0008_. Feel free to also use flake8_ to help.

LICENSE

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,23 @@
1-
Redistribution and use in source and binary forms, with or without
2-
modification, are permitted provided that the following conditions are
1+
Redistribution and use in source and binary forms, with or without
2+
modification, are permitted provided that the following conditions are
33
met:
44

5-
1. Redistributions of source code must retain the above copyright
5+
1. Redistributions of source code must retain the above copyright
66
notice, this list of conditions and the following disclaimer.
7-
2. Redistributions in binary form must reproduce the above copyright
8-
notice, this list of conditions and the following disclaimer in the
7+
2. Redistributions in binary form must reproduce the above copyright
8+
notice, this list of conditions and the following disclaimer in the
99
documentation and/or other materials provided with the distribution.
10-
3. The name of the author may not be used to endorse or promote products
10+
3. The name of the author may not be used to endorse or promote products
1111
derived from this software without specific prior written permission.
1212

13-
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14-
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15-
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16-
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
17-
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18-
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19-
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20-
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21-
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
22-
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
13+
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
14+
IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
15+
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
16+
DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT,
17+
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
18+
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
19+
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20+
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
21+
STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
22+
ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2323
POSSIBILITY OF SUCH DAMAGE.

README.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
.. image::
22
https://raw.github.com/sigmavirus24/github3.py/master/docs/img/gh3-logo.png
33

4-
github3.py is a comprehensive, actively developed and extraordinarily stable
4+
github3.py is a comprehensive, actively developed and extraordinarily stable
55
wrapper around the GitHub API (v3).
66

77
Note: This library currently works with Python 3.6+ or pypy3. For older versions, please use version 1.3.0.
@@ -32,8 +32,8 @@ Please read the `CONTRIBUTING`_ document.
3232
Testing
3333
~~~~~~~
3434

35-
You can run either ``pip install -r dev-requirements.txt`` to install the
36-
following before testing or simply ``make test-deps``. It is suggested you do
35+
You can run either ``pip install -r dev-requirements.txt`` to install the
36+
following before testing or simply ``make test-deps``. It is suggested you do
3737
this in a virtual environment. These need to be installed for the tests to run.
3838

3939
- betamax_
@@ -86,11 +86,11 @@ Ian Stapleton Cordasco (sigmavirus24_)
8686
Contact Options
8787
---------------
8888

89-
- Feel free to use the `github3.py`_ tag on Stack Overflow for any questions
89+
- Feel free to use the `github3.py`_ tag on Stack Overflow for any questions
9090
you may have
91-
- If you dislike Stack Overflow it is preferred that you send an email to
91+
- If you dislike Stack Overflow it is preferred that you send an email to
9292
93-
- You may also contact (via email_) the author directly with
93+
- You may also contact (via email_) the author directly with
9494
questions/suggestions/comments or if you wish to include sensitive data.
9595

9696
.. _github3.py: http://stackoverflow.com/questions/tagged/github3.py

example-notebooks/all_repositories.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,4 +129,4 @@
129129
"metadata": {}
130130
}
131131
]
132-
}
132+
}

example-notebooks/contents-api.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -609,4 +609,4 @@
609609
"metadata": {}
610610
}
611611
]
612-
}
612+
}

example-notebooks/forking_repositories_by.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,4 +173,4 @@
173173
"metadata": {}
174174
}
175175
]
176-
}
176+
}

example-notebooks/managing_issues.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -400,4 +400,4 @@
400400
"metadata": {}
401401
}
402402
]
403-
}
403+
}

example-notebooks/public_gist_api.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@
159159
"metadata": {}
160160
}
161161
]
162-
}
162+
}

example-notebooks/retrieving_issues_on_a_repository.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -366,4 +366,4 @@
366366
"metadata": {}
367367
}
368368
]
369-
}
369+
}

example-notebooks/statuses-api.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -304,4 +304,4 @@
304304
"metadata": {}
305305
}
306306
]
307-
}
307+
}

0 commit comments

Comments
 (0)