Skip to content

Commit 5ebfa1c

Browse files
committed
Add documentation for new hatch commands
1 parent 3a1cb6e commit 5ebfa1c

File tree

8 files changed

+114
-311
lines changed

8 files changed

+114
-311
lines changed

.github/workflows/check.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
uses: ./.github/workflows/.hatch-run.yml
2121
with:
2222
job-name: "python-{0}"
23-
run-cmd: "hatch run python:check"
23+
run-cmd: "hatch fmt src/reactpy --check && hatch run python:type_check"
2424
test-python:
2525
uses: ./.github/workflows/.hatch-run.yml
2626
with:

docs/source/_exts/autogen_api_docs.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -104,10 +104,10 @@ def walk_python_files(root: Path, ignore_dirs: Collection[str]) -> Iterator[Path
104104
105105
We yield the files in this order::
106106
107-
project/__init__.py
108-
project/package/__init__.py
109-
project/package/module_a.py
110-
project/module_b.py
107+
project / __init__.py
108+
project / package / __init__.py
109+
project / package / module_a.py
110+
project / module_b.py
111111
112112
In this way we generate the section titles in the appropriate order::
113113

docs/source/about/changelog.rst

Lines changed: 4 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,7 @@ Changelog
55

66
All notable changes to this project will be recorded in this document. The style of
77
which is based on `Keep a Changelog <https://keepachangelog.com/>`__. The versioning
8-
scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__. For
9-
more info, see the :ref:`Contributor Guide <Creating a Changelog Entry>`.
8+
scheme for the project adheres to `Semantic Versioning <https://semver.org/>`__.
109

1110

1211
.. INSTRUCTIONS FOR CHANGELOG CONTRIBUTORS
@@ -20,7 +19,7 @@ Unreleased
2019

2120
**Changed**
2221

23-
- :pull:`1251` Substitute ``react`` rendering on the client with ``preact``.
22+
- :pull:`1251` Substitute client-side usage of ``react`` with ``preact``.
2423

2524
v1.1.0
2625
------
@@ -44,12 +43,8 @@ v1.1.0
4443
**Changed**
4544

4645
- :pull:`1171` - Previously ``None``, when present in an HTML element, would render as
47-
the string ``"None"``. Now ``None`` will not render at all. This is consistent with
48-
how ``None`` is handled when returned from components. It also makes it easier to
49-
conditionally render elements. For example, previously you would have needed to use a
50-
fragment to conditionally render an element by writing
51-
``something if condition else html._()``. Now you can simply write
52-
``something if condition else None``.
46+
the string ``"None"``. Now ``None`` will not render at all. This is now equivalent to
47+
how ``None`` is handled when returned from components.
5348
- :pull:`1210` - Move hooks from ``reactpy.backend.hooks`` into ``reactpy.core.hooks``.
5449

5550
**Deprecated**

0 commit comments

Comments
 (0)