Precommit config update

Author: lwasser

package-structure-code/intro.md

@@ -1,73 +1,64 @@
-# Python package structure information 
+# Python package structure information
 
-If you plan to submit a package for review to pyOpenSci and are looking for 
-some guidance on package structure, code formats and style, then this section 
-is for you. 
+If you plan to submit a package for review to pyOpenSci and are looking for
+some guidance on package structure, code formats and style, then this section
+is for you.
 
 <!-- TODO: move this either to the top of this section or the landing page?-->
 
 ```{note}
-Have a look at the 
+Have a look at the
 bare-minimum [editor checks](https://www.pyopensci.org/peer-review-guide/software-peer-review-guide/editor-in-chief-guide.html#editor-checklist-template) that pyOpenSci
-performs before a review begins. These checks are useful to explore 
-for both authors planning to submit a package to us for review and for 
-anyone who is just getting started with creating a Python package. 
+performs before a review begins. These checks are useful to explore
+for both authors planning to submit a package to us for review and for
+anyone who is just getting started with creating a Python package.
 
-In general these are basic items that should be in any open software repository. 
+In general these are basic items that should be in any open software repository.
 ```
 
-## Guidelines for pyOpenSci's packaging recommendations 
+## Guidelines for pyOpenSci's packaging recommendations
 
 <!-- Might belong on the LANDING page for this entire guide?-->
 
-Python is a flexible programming language that is used across numerous 
-disciplines and domains. Python is so flexible that it is one of the few 
+Python is a flexible programming language that is used across numerous
+disciplines and domains. Python is so flexible that it is one of the few
 languages that can be used to wrap around other languages.
 
-If you are building a pure Python package, then your packaging setup can be 
-simple. However, some scientific packages have complex requirements as they may 
+If you are building a pure Python package, then your packaging setup can be
+simple. However, some scientific packages have complex requirements as they may
 need to support extensions or tools written in other languages such as C or C++.
 
-To support the many different uses of Python, there are many ways to create a 
-Python package. 
+To support the many different uses of Python, there are many ways to create a
+Python package.
 
 The ecosystem is dynamic, and constantly evolving to support
-the numerous needs that developers (and scientists) have using Python. 
+the numerous needs that developers (and scientists) have using Python.
 
-This dynamic yet flexible environment is what many love about Python. 
+This dynamic yet flexible environment is what many love about Python.
 
-## What you will learn here 
+## What you will learn here
 
 In this section of our Python packaging guide, we try to:
 
-* Provide an overview of the options available to you when packaging your tool 
-* Suggest tools and approaches that both meet your needs and also support existing standards. 
-* Suggest tools and approaches that will allow you to expand upon a workflow that may begin as a pure Python tool and evolve into a tool that requires addition layers of complexity in the packaging build. 
+* Provide an overview of the options available to you when packaging your tool
+* Suggest tools and approaches that both meet your needs and also support existing standards.
+* Suggest tools and approaches that will allow you to expand upon a workflow that may begin as a pure Python tool and evolve into a tool that requires addition layers of complexity in the packaging build.
 * Align our suggestions with the most current, accepted
-[PEPs (Python Enhancement Protocols)](https://peps.python.org/pep-0000/) and the [scientific-python community SPECs](https://scientific-python.org/specs/). 
-* In an effort to maintain consistency withint our community , we also align with existing best practices being implemented by developers of core Scientific Python packages such as numpy, scipy and others. 
+[PEPs (Python Enhancement Protocols)](https://peps.python.org/pep-0000/) and the [scientific-python community SPECs](https://scientific-python.org/specs/).
+* In an effort to maintain consistency withint our community , we also align with existing best practices being implemented by developers of core Scientific Python packages such as numpy, SciPy and others.
 
 
-
-
-<!-- 
-
-These checks include several items
-
-- **Sufficient Documentation** The package has sufficient documentation available online (README, sphinx docs) to allow us to evaluate package function and scope *without installing the package*. This includes:
-  Get started tutorials or vignettes that help a user understand how to use the package and what it can do for them (often these have a name like "Getting started")
-- **API documentation** - this includes clearly written doc strings with variables defined using a standard docstring format -->
-<!-- 
+<!--
 ```{tip}
-### Python packaging resources that we love 
+### Python packaging resources that we love
 
-We think the resources below are excellent but each have particular opinions 
+We think the resources below are excellent but each have particular opinions
 that you may or may not find in our packaging guide. For instance, the PyPA
 guide encourages users to store their package in a `src/package-name` directory.
-While we accept that approach many of our community members prefer to not use 
-the `src` directory. 
+While we accept that approach many of our community members prefer to not use
+the `src` directory.
 
 * [Python packaging for research software engineers](https://merely-useful.tech/py-rse/)
 * [PyPA packaging guide](https://packaging.python.org/en/latest/)
 ```
--->
+-->