Pre-commit hook fixes (#53)

zillow · May 23, 2024 · 314308a · 314308a
1 parent 5596ca9
commit 314308a
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 8 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -4,7 +4,6 @@ repos:
   hooks:
     - id: check-case-conflict
     - id: check-merge-conflict
-    - id: end-of-file-fixer
     - id: trailing-whitespace
 - repo: https://github.com/psf/black
   rev: 24.2.0

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -8,11 +8,11 @@ All contributions, suggestions, and feedback you submitted are accepted under th
 
 ## Submitting an Issue
 
-[Issues](https://github.com/zillow/quantile-forest/issues) should be used to report problems with the package or any of its dependencies, request a new feature, or to discuss potential changes before a PR is created. 
+[Issues](https://github.com/zillow/quantile-forest/issues) should be used to report problems with the package or any of its dependencies, request a new feature, or to discuss potential changes before a PR is created.
 
 When reporting bugs, please provide a [minimal reproducible example](https://stackoverflow.com/help/minimal-reproducible-example), the version of the package, and the environment (e.g., Python version).
 
-If you find an existing Issue that addresses the problem you're having, please add your own reproducible example to the existing issue rather than creating a new one. 
+If you find an existing Issue that addresses the problem you're having, please add your own reproducible example to the existing issue rather than creating a new one.
 
 ## Submitting a Pull Request
 

diff --git a/docs/_static/css/gallery.css b/docs/_static/css/gallery.css
@@ -84,7 +84,7 @@ div.bottomnav {
   padding-right: 1rem;
 }
 #showcase .preview {
-  /* Value is chosen through trial and error so that the examples fill out the 
+  /* Value is chosen through trial and error so that the examples fill out the
   whole width which is defined in #showcase .examples */
   width: 172px;
   height: 100px;

diff --git a/docs/_templates/navbar-project.html b/docs/_templates/navbar-project.html
@@ -1,4 +1,3 @@
 <a class="navbar-brand" href="{{ pathto(master_doc) }}">
 <p class="title">{{ project }}</p>
 </a>
-
diff --git a/docs/getting_started/developers.rst b/docs/getting_started/developers.rst
@@ -3,13 +3,21 @@
 Developer's Guide
 -----------------
 
-Development Installation
+Development Dependencies
 ~~~~~~~~~~~~~~~~~~~~~~~~
-
 Building the package from source additionally requires the following dependencies:
 
 * cython (>=3.0a4)
 
+We also use pre-commit hooks to identify simple issues before submission.
+
+To install these dependencies, run::
+
+  pip install cython pre-commit
+
+Development Installation
+~~~~~~~~~~~~~~~~~~~~~~~~
+
 To manually build and install the package, run::
 
   pip install --verbose --editable .

diff --git a/setup.cfg b/setup.cfg
@@ -19,7 +19,7 @@ max-line-length = 100
 ignore = E203, E266, E402, E501, W503
 max-complexity = 19
 select = B,C,E,F,W,T4,B9
-exclude = 
+exclude =
   .git,
   build,
   __pycache__