Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[pre-commit.ci] pre-commit autoupdate #19

Closed
wants to merge 7 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -30,3 +30,6 @@ panel-examples
deploy-panel.html
test.png
pyviz.pkl

# vale
styles/*
25 changes: 18 additions & 7 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ ci:

repos:
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.6.0
rev: v5.0.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
Expand All @@ -21,6 +21,11 @@ repos:
- id: check-json
types: [file] # override `types: [json]`
files: \.(json|ipynb)$
- repo: https://github.com/sphinx-contrib/sphinx-lint
rev: v1.0.0
hooks:
- id: sphinx-lint
types: [rst]
- repo: https://github.com/pycqa/isort
rev: 5.13.2
hooks:
Expand All @@ -29,12 +34,18 @@ repos:
entry: isort --profile=black
name: isort (python)
- repo: https://github.com/psf/black
rev: 24.8.0
rev: 24.10.0
hooks:
- id: black
- repo: https://github.com/sphinx-contrib/sphinx-lint
rev: v0.9.1
- repo: https://github.com/adamchainz/blacken-docs
rev: "1.19.0"
hooks:
- id: sphinx-lint
args: [--jobs=1]
types: [rst]
- id: blacken-docs
args: [--line-length=79]
additional_dependencies:
- black
- repo: https://github.com/codespell-project/codespell
rev: v2.3.0
hooks:
- id: codespell
args: [--toml pyproject.toml]
11 changes: 5 additions & 6 deletions .vale.ini
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,11 @@
#
# SPDX-License-Identifier: BSD-3-Clause

StylesPath = ./styles
StylesPath = styles
MinAlertLevel = suggestion

[*.{md,rst}]
BasedOnStyles = cusy
Packages = https://github.com/cusyio/cusy-vale/archive/refs/tags/v0.1.0.zip

vale.Redundancy = YES
vale.Repetition = YES
vale.GenderBias = YES
[*.{md,rst}]
TokenIgnores = (:linenos:)
BasedOnStyles = cusy-en
8 changes: 4 additions & 4 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -130,15 +130,15 @@ Installation

You can find the PDF at ``docs/_build/latex/jupytertutorial.pdf``.

#. Install vnd run ale to check spelling
#. Install and run ale to check spelling

You can install Vale with:

.. code-block:: console

$ brew install vale

You can install the parser for Restructuredtext with:
You can install the parser for reStructuredText with:

.. code-block:: console

Expand All @@ -148,7 +148,7 @@ Installation
* `Vale installation <https://docs.errata.ai/vale/install>`_
* `Vale formats <https://docs.errata.ai/vale/scoping#formats>`_

Now you can check the RestructuredText files with:
Now you can check the reStructuredText files with:

.. code-block:: console

Expand Down Expand Up @@ -176,6 +176,6 @@ suggestions.
The following guidelines help us to maintain the German translation of the
tutorial:

* Write commit messages in Englisch
* Write commit messages in English
* Start commit messages with a `Gitmoji <https://gitmoji.dev/>`__
* Stick to English names of files and folders.
2 changes: 1 addition & 1 deletion docs/clean-prep/string-matching.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"## 2. Imort"
"## 2. Import"
]
},
{
Expand Down
2 changes: 1 addition & 1 deletion docs/data-processing/apis/grpc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ specifies the communication between clients and servers:
#. First the stream is started by the client with a mandatory ``Call Header``

#. followed by optional ``Initial-Metadata``
#. followd by optional ``Payload Messages``.
#. followed by optional ``Payload Messages``.

The contents of ``Call Header`` and ``Initial Metadata`` are sent as HTTP/2
headers compressed with ``HPACK``.
Expand Down
4 changes: 2 additions & 2 deletions docs/data-processing/apis/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
..
.. SPDX-License-Identifier: BSD-3-Clause

**A**\pplication **P**\rogramming **I**\nterface (API)
======================================================
Application Programming Interface (API)
=======================================

APIs can be used to provide the data. :doc:`fastapi/index` is a library that can
generate APIs and documentation based on `OpenAPI <https://www.openapis.org/>`_
Expand Down
Loading
Loading