From a6ff554c6e594b6bed0b9ba54f29296babc71e70 Mon Sep 17 00:00:00 2001 From: Sangjoon Bob Lee Date: Wed, 15 Jan 2025 11:01:07 -0500 Subject: [PATCH] chore: apply pre-commit and fix spelling --- doc/source/frequently-asked-questions.rst | 6 +++--- doc/source/getting-started.rst | 2 +- doc/source/release-guide.rst | 2 +- doc/source/scikit-package-guide.rst | 4 ++-- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/frequently-asked-questions.rst b/doc/source/frequently-asked-questions.rst index f595f7f..9bdc529 100644 --- a/doc/source/frequently-asked-questions.rst +++ b/doc/source/frequently-asked-questions.rst @@ -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/ @@ -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 ^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/doc/source/getting-started.rst b/doc/source/getting-started.rst index f8a4d6d..20193f9 100644 --- a/doc/source/getting-started.rst +++ b/doc/source/getting-started.rst @@ -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 `. -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 `. +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 `. 3. Do you want to start a new Python project with ``scikit-package``? Start from the scikit-package workflow section :ref:`here `. diff --git a/doc/source/release-guide.rst b/doc/source/release-guide.rst index 7507374..148e8c0 100644 --- a/doc/source/release-guide.rst +++ b/doc/source/release-guide.rst @@ -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 `. +.. important:: Make sure you have your project is standarlized with scikit-package. Otherwise, please start from the Getting started page :ref:`here `. #. In the repository, create an issue on GitHub with the "Release" option as shown below: diff --git a/doc/source/scikit-package-guide.rst b/doc/source/scikit-package-guide.rst index 20abc66..d0c896d 100644 --- a/doc/source/scikit-package-guide.rst +++ b/doc/source/scikit-package-guide.rst @@ -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 `! +.. Important:: Are you starting a new project? Skip this section and go to :ref:`2. scikit-package main workflow `! #. 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 `. @@ -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 `. - + 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 `_. #. 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``.