Skip to content

Commit

Permalink
chore: apply pre-commit and fix spelling
Browse files Browse the repository at this point in the history
  • Loading branch information
bobleesj committed Jan 15, 2025
1 parent a4c01ba commit a6ff554
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
6 changes: 3 additions & 3 deletions doc/source/frequently-asked-questions.rst
Original file line number Diff line number Diff line change
Expand Up @@ -219,7 +219,7 @@ The following practices have been developed to ensure consistency in writing tes

#. Use descriptive yet concise variable names for expected values (e.g., ``expected_xarrays`` instead of ``expected``)

#. Order test cases from the most general to edge cases. This helps readers understand the basic function behavior first before utilizing or encountering unusual features or behaviors.
#. Order test cases from the most general to edge cases. This helps readers understand the basic function behavior first before utilizing or encountering unusual features or behaviors.

#. Consider moving reusable code objects to ``conftest.py``. See warning messages and objects defined in https://github.com/diffpy/diffpy.utils/blob/main/tests/conftest.py available in each test function in https://github.com/diffpy/diffpy.utils/blob/main/tests/test_diffraction_objects.py/

Expand Down Expand Up @@ -325,12 +325,12 @@ In the group, we follow the NumPy standard:

#. Full docstrings are not required for private functions.

For examples, please refer to https://github.com/diffpy/diffpy.utils/blob/main/src/diffpy/utils/diffraction_objects.py.
For examples, please refer to https://github.com/diffpy/diffpy.utils/blob/main/src/diffpy/utils/diffraction_objects.py.

How we design error message
^^^^^^^^^^^^^^^^^^^^^^^^^^^

Divide an error message into two sections: (1) reason for error, (2) what to do to fix it. Ex) "Both release and pre-release specified. Please re-run the command specifying either release or pre_release.” Error messages are for users. Consider users without programming knowledge.
Divide an error message into two sections: (1) reason for error, (2) what to do to fix it. Ex) "Both release and pre-release specified. Please re-run the command specifying either release or pre_release.” Error messages are for users. Consider users without programming knowledge.

How we write file names
^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting-started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Are you here to standardize your Python project with scikit-package?

1. You have an existing Python project. Do you want to standardize your project with ``scikit-package``? Please follow the full instructions :ref:`here <scikit-package-header>`.

2. You already have a scikit-packageed project. Do you want to use the latest version of ``scikit-package`` to re-standard your projet? Please follow the instructions in :ref:`here <scikit-package-workflow-main>`.
2. You already have a scikit-packageed project. Do you want to use the latest version of ``scikit-package`` to re-standard your project? Please follow the instructions in :ref:`here <scikit-package-workflow-main>`.

3. Do you want to start a new Python project with ``scikit-package``? Start from the scikit-package workflow section :ref:`here <scikit-package-workflow-main>`.

Expand Down
2 changes: 1 addition & 1 deletion doc/source/release-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ PyPI/GitHub release

.. _release-instructions-contributor:

.. important:: Make sure you have your proejct is standarlized with scikit-package. Otherwise, please start from the Getting started page :ref:`here <getting-started>`.
.. important:: Make sure you have your project is standarlized with scikit-package. Otherwise, please start from the Getting started page :ref:`here <getting-started>`.

#. In the repository, create an issue on GitHub with the "Release" option as shown below:

Expand Down
4 changes: 2 additions & 2 deletions doc/source/scikit-package-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ We offer the following ways to help guide you through the scikit-package process
1. Pre-commit workflow
----------------------

.. Important:: Are you starting a new proejct? Skip this section and go to :ref:`2. scikit-package main workflow <scikit-package-workflow-main>`!
.. Important:: Are you starting a new project? Skip this section and go to :ref:`2. scikit-package main workflow <scikit-package-workflow-main>`!

#. Fork the repository and clone your forked your repository to your local. If you are not familiar with GitHub workflows, please refer our brief guide provided :ref:`here <github-workflow-overview>`.

Expand Down Expand Up @@ -117,7 +117,7 @@ We offer the following ways to help guide you through the scikit-package process
.. note::

Q1. Do you want to ignore certain spelling recommendations by Codespell? Please refer to this section in the FAQ :ref:`here <codespell-add-word>`.

Q2. Do you want to prevent certain automatic modifications on specific file types? You can add the folder or extension to the ``exclude`` section in ``.pre-commit-config.yaml``. Check <https://github.com/Billingegroup/scikit-package/blob/main/.pre-commit-config.yaml>`_.

#. At this point, you may have flake8 errors but we want to address them in a separate pull request. Hence, git add and commit and push the automatic changes made by ``precommit`` and create a pull request to ``main``. The commit message can be ``style: apply pre-commit without manual modification`` and the pull request title can be ``scikit-package: Apply pre-commit to project directory with no manual edits``.
Expand Down

0 comments on commit a6ff554

Please sign in to comment.