pythonic-fp-booleans 3.0.0__tar.gz → 3.0.1__tar.gz

pythonic_fp_booleans-3.0.1/.github/workflows/static.yml

@@ -0,0 +1,59 @@
+name: Build and Deploy Furo Themed Sphinx Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v6
+
+      - name: Select Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install Sphinx Dependencies
+        run: pip install -r docs/requirements.txt
+
+      - name: Build release docs
+        run: |
+          pip install pythonic-fp-booleans
+          cp docs/index_release.rst docs/source/index.rst
+          cp docs/conf_release.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/release
+
+      - name: Build development docs
+        run: |
+          pip install -e .
+          cp docs/index_devel.rst docs/source/index.rst
+          cp docs/conf_devel.py docs/source/conf.py
+          sphinx-build -M html docs/source docs/build/development
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v6
+
+      - name: Upload Artifact
+        uses: actions/upload-pages-artifact@v5
+        with:
+          path: docs/build
+
+      - name: Deploy to GitHub Pages
+        uses: actions/deploy-pages@v5
+        id: deployment

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/.gitignore

@@ -1,6 +1,10 @@
 # Minimal version - only add to when necessary
 **/__pycache__/
 dist/
+docs/build/release/
+docs/build/development/
+docs/source/conf.py
+docs/source/index.rst
 **/.dmypy.json
 **/.mypy_cache/
 **/.pytest_cache/

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/CHANGELOG.rst

@@ -17,7 +17,16 @@ See `Semantic Versioning 2.0.0 <https://semver.org>`_.
 Releases and Important Milestones
 ---------------------------------
 
-PyPI 2.2.0 - 2025-12-02
+PyPI 3.0.1 - 2025-12-02
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The pythonic-fp-booleans GitHub repo now will be automatically
+building the current release documentation and the latest development
+documentation on GitHub for display on the project's GitHub Pages.
+
+Substantial documentation improvements.
+
+PyPI 3.0.0 - 2025-12-02
 ~~~~~~~~~~~~~~~~~~~~~~~
 
 Docstring updates.

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pythonic-fp-booleans
-Version: 3.0.0
+Version: 3.0.1
 Summary: Subtypable Boolean Class Hierarchy
 Keywords: booleans,subtypable
 Author-email: "Geoffrey R. Scheller" <geoffrey@scheller.com>
@@ -44,7 +44,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/booleans>`_.
+<https://grscheller.github.io/pythonic-fp-booleans>`_.
 
 Copyright and License
 ---------------------

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/README.rst

@@ -20,7 +20,7 @@ Documentation
 
 Documentation for this project is hosted on
 `GitHub Pages
-<https://grscheller.github.io/pythonic-fp/booleans>`_.
+<https://grscheller.github.io/pythonic-fp-booleans>`_.
 
 Copyright and License
 ---------------------

pythonic_fp_booleans-3.0.1/docs/Makefile

@@ -0,0 +1,69 @@
+# Makefile for Sphinx documentation
+#
+# Important Note: "make devel" and "make release" will just
+# use the first pythonic_fp.circulararray package found.
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+STATICDIR     = source/_static
+TEMPLATEDIR   = source/_templates
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
+
+setup_init: Makefile
+	mkdir -p $(STATICDIR) $(TEMPLATEDIR)
+
+setup_devel: setup_init
+	rm -rf "$(BUILDDIR)"/development
+	cp index_devel.rst "$(SOURCEDIR)"/index.rst
+	cp conf_devel.py "$(SOURCEDIR)"/conf.py
+
+setup_release: setup_init
+	rm -rf "$(BUILDDIR)"/release
+	cp index_release.rst "$(SOURCEDIR)"/index.rst
+	cp conf_release.py "$(SOURCEDIR)"/conf.py
+
+setup_custom: setup_init
+	rm -rf "$(BUILDDIR)"/custom
+	cp index_custom.rst "$(SOURCEDIR)"/index.rst
+	cp conf_custom.py "$(SOURCEDIR)"/conf.py
+
+clean_source: Makefile
+	@rm -f "$(SOURCEDIR)"/conf.py "$(SOURCEDIR)"/index.rst
+
+clean_devel: clean_source
+	@rm -rf "$(BUILDDIR)"/development
+
+clean_release: clean_source
+	@rm -rf "$(BUILDDIR)"/release
+
+clean_custom: clean_source
+	@rm -rf "$(BUILDDIR)"/custom
+
+clean: clean_devel clean_release clean_custom
+	@echo Removed all doc build artifacts.
+
+.PHONY: help Makefile
+.PHONY: setup_init setup_devel setup_release
+.PHONY: devel release
+.PHONY: clean_source clean_devel clean_release clean
+
+# Build development labeled html docs.
+devel: setup_devel
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/development $(SPHINXOPTS)
+
+# Build release labeled html docs.
+release: setup_release
+	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)"/release $(SPHINXOPTS)
+
+# Catch-all target: route all unknown targets to Sphinx and save to $(BUILDDIR)/custom.
+# Use conf_custom.py and index_custom.html to configure.
+%: Makefile setup_custom
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)"/custom $(SPHINXOPTS)

pythonic_fp_booleans-3.0.1/docs/build/index.html

@@ -0,0 +1,44 @@
+<!doctype html>
+<html lang="en">
+
+<head>
+  <meta charset="UTF-8" />
+  <title>PyPI Project: pythonic-fp-booleans</title>
+  <link rel="stylesheet" href="style.css" />
+</head>
+
+<body>
+  <table>
+    <tr>
+      <td>
+        <h3>Pythonic FP Booleans</h3>
+        <dl>
+          <dt>Booleans - pythonic-fp-booleans:</dt>
+          <dd><a href="https://pypi.org/project/pythonic-fp-booleans/"> PyPI</a></dd>
+          <dd><a href="https://github.com/grscheller/pythonic-fp-booleans"> GitHub</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Booleans Documentation:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-booleans/release/html/"> Latest release</a></dd>
+          <dd><a href="https://grscheller.github.io/pythonic-fp-booleans/development/html/"> Development</a></dd>
+        </dl>
+      </td>
+
+      <td>
+        <h3>Related PyPI Projects</h3>
+        <dl>
+          <dt>Pythonic Functional Programming:</dt>
+          <dd><a href="https://grscheller.github.io/pythonic-fp/"> Pythonic FP Homepage</a></dd>
+        </dl>
+
+        <dl>
+          <dt>Daddy's Boring Math Library :</dt>
+          <dd><a href="https://grscheller.github.io/boring-math/"> Boring Math Homepage</a></dd>
+        </dl>
+      </td>
+    </tr>
+  </table>
+</body>
+
+</html>

pythonic_fp_booleans-3.0.1/docs/build/style.css

@@ -0,0 +1,44 @@
+body {
+    color: #c5c9c5;
+    background-color: #181616;
+    font-family: cantarell,liberation,arial,helvetica,sans-serif
+}
+
+a:link {
+    color: #6884c0;
+    text-decoration: none;
+}
+
+a:visited {
+    color: #7e9cd8;
+    text-decoration: none;
+}
+
+a:hover {
+    text-decoration: underline;
+}
+
+h3 {
+    color: #b6927b;
+    margin-left: 20px;
+}
+
+table {
+    width: 100%;
+}
+
+td {
+    vertical-align: top;
+}
+
+dt {
+    color: #acafac;
+    margin-left: 20px;
+    margin-top: 5px;
+}
+
+dd {
+    color: #c5c9c5;
+    margin-left: 20px;
+    padding-left: 15px;
+}

pythonic_fp_booleans-3.0.1/docs/conf_custom.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Booleans'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '0.0.0'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': False,
+    'show-inheritance': True,
+}
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_booleans-3.0.1/docs/conf_devel.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Booleans'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '3.0.1'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': False,
+    'show-inheritance': True,
+}
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_booleans-3.0.1/docs/conf_release.py

@@ -0,0 +1,68 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# https://www.sphinx-doc.org/en/master/usage/index.html
+#
+# Must match what is in pyproject.toml, also delete "Proposed"
+# in the release string in source/index.rst when generating
+# the docs for an actual, not proposed, release.
+
+from typing import Any
+from sphinx.application import Sphinx
+
+project = 'Pythonic FP - Booleans'
+copyright = '2023-2026, Geoffrey R. Scheller'
+author = 'Geoffrey R. Scheller'
+release = '3.0.0'
+
+
+def skip_abc_methods(
+    app: Any, what: str, name: str, obj: Any, skip: bool, options: Any
+) -> bool:
+    if name in [
+        '__init_subclass__',
+        '__subclasshook__',
+        '__class_getitem__',
+        '__weakref__',
+    ]:
+        return True  # Skip these members
+    return skip
+
+
+def setup(app: Sphinx) -> None:
+    app.connect('autodoc-skip-member', skip_abc_methods)
+
+
+extensions = [
+    'sphinx.ext.autodoc',
+    'sphinx.ext.graphviz',
+]
+
+autodoc_default_options = {
+    'members': True,
+    'private-members': True,
+    'special-members': True,
+    'inherited-members': False,
+    'show-inheritance': True,
+}
+autodoc_member_order = 'bysource'
+autoclass_content = 'both'
+autodoc_class_signature = 'separated'
+autodoc_typehints_format = 'short'
+autodoc_use_type_comments = True
+autodoc_docstring_signature = False
+autodoc_preserve_defaults = True
+autodoc_warningiserror = False
+
+templates_path = ['_templates']
+exclude_patterns: list[str] = []
+
+html_theme_options = {
+    'light_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+    'dark_css_variables': {
+        'color-link--visited': 'var(--color-link)',
+    },
+}
+html_theme = 'furo'
+html_static_path = ['_static']

pythonic_fp_booleans-3.0.1/docs/index_custom.rst

@@ -0,0 +1,30 @@
+pythonic-fp-booleans
+====================
+
+Project
+`pythonic-fp-booleans <https://pypi.org/project/pythonic-fp-booleans/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**Custom PyPI 0.0.0 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_booleans-3.0.1/docs/index_devel.rst

@@ -0,0 +1,30 @@
+pythonic-fp-booleans
+====================
+
+Project
+`pythonic-fp-booleans <https://pypi.org/project/pythonic-fp-booleans/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**Proposed PyPI 3.0.1 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_booleans-3.0.1/docs/index_release.rst

@@ -0,0 +1,30 @@
+pythonic-fp-booleans
+====================
+
+Project
+`pythonic-fp-booleans <https://pypi.org/project/pythonic-fp-booleans/>`_
+one of the
+`Pythonic FP <https://grscheller.github.io/pythonic-fp/>`_
+PyPI projects.
+
+**PyPI 3.0.0 release**
+
+.. toctree::
+    :caption: Overview
+    :hidden:
+
+    self
+
+.. toctree::
+    :caption: User Documentation
+
+    description
+    usage
+    releases
+    changelog
+
+.. toctree::
+    :caption: API Documentation
+    :maxdepth: 1
+
+    docs/index

pythonic_fp_booleans-3.0.1/docs/requirements.txt

@@ -0,0 +1,2 @@
+sphinx>=9.1
+furo

pythonic_fp_booleans-3.0.1/docs/source/changelog.rst

@@ -0,0 +1,7 @@
+Changelog
+=========
+
+Change log for the
+`pythonic-fp-booleans
+<https://github.com/grscheller/pythonic-fp-booleans/blob/main/CHANGELOG.rst>`_
+PyPI project.

pythonic_fp_booleans-3.0.1/docs/source/description.rst

@@ -0,0 +1,7 @@
+Description
+-----------
+
+.. automodule:: pythonic_fp.booleans
+    :synopsis:
+    :noindex:
+

pythonic_fp_booleans-3.0.1/docs/source/docs/flavored.rst

@@ -0,0 +1,4 @@
+module flavored
+---------------
+
+.. automodule:: pythonic_fp.booleans.flavored

pythonic_fp_booleans-3.0.1/docs/source/docs/index.rst

@@ -0,0 +1,15 @@
+Subtypable Booleans
+-------------------
+
+.. toctree::
+    :caption: Subtypable Boolean
+    :maxdepth: 1
+
+    subtypable
+
+.. toctree::
+    :caption: Subtypable Boolean examples
+    :maxdepth: 1
+
+    flavored
+    truthy_falsy

pythonic_fp_booleans-3.0.1/docs/source/docs/subtypable.rst

@@ -0,0 +1,8 @@
+module subtypable
+-----------------
+
+**True Booleans, not a subtypes of ``int``, unlike ``bool`` these are subtypable.**
+
+.. automodule:: pythonic_fp.booleans.subtypable
+    :members:
+    :special-members:

pythonic_fp_booleans-3.0.1/docs/source/docs/truthy_falsy.rst

@@ -0,0 +1,4 @@
+module truthy_falsy
+-------------------
+
+.. automodule:: pythonic_fp.booleans.truthy_falsy

pythonic_fp_booleans-3.0.1/docs/source/releases.rst

@@ -0,0 +1,24 @@
+PyPI releases
+=============
+
+**pythonic-fp-booleans:** pythonic_fp.booleans
+
++--------------------------------------------------------------------------------------+--------------+
+| PyPI Release                                                                         | Release Date |
++======================================================================================+==============+
+| `development <https://grscheller.github.io/pythonic-fp-booleans/development/html/>`_ |              |
++--------------------------------------------------------------------------------------+--------------+
+| `v3.0.0 <https://grscheller.github.io/pythonic-fp-booleans/release/html/>`_          | 2026-01-12   |
++--------------------------------------------------------------------------------------+--------------+
+| v2.1.0                                                                               | 2025-12-02   |
++--------------------------------------------------------------------------------------+--------------+
+| v2.0.0                                                                               | 2025-09-27   |
++--------------------------------------------------------------------------------------+--------------+
+| v1.1.2                                                                               | 2025-09-09   |
++--------------------------------------------------------------------------------------+--------------+
+| v1.1.1                                                                               | 2025-09-03   |
++--------------------------------------------------------------------------------------+--------------+
+| v1.1.0                                                                               | 2025-09-02   |
++--------------------------------------------------------------------------------------+--------------+
+| v1.0.0 (pythonic-fp-singletons)                                                      | 2025-08-02   |
++--------------------------------------------------------------------------------------+--------------+

pythonic_fp_booleans-3.0.1/docs/source/usage.rst

@@ -0,0 +1,63 @@
+Usage
+=====
+
+How to installing the package
+-----------------------------
+
+Install the project into your Python environment:
+
+.. code:: console
+
+    $ pip install pythonic-fp.booleans
+
+Importing the package
+---------------------
+
+Import package booleans classes, functions and constants into your code.
+
+.. code:: python
+
+    from pythonic_fp.booleans.subtypable SBool, snot, TRUTH, LIE
+
+    from pythonic_fp.booleans.subtypes.flavored FBool, truthy, falsy
+
+    from pythonic_fp.booleans.subtypes.truthy_falsy TF_Booleans
+    from pythonic_fp.booleans.subtypes.truthy_falsy TF_Bool, T_Bool, F_Bool
+    from pythonic_fp.booleans.subtypes.truthy_falsy ALWAYS, NEVER_EVER
+
+Best practices
+--------------
+
+Subtypable Booleans
+~~~~~~~~~~~~~~~~~~~
+
+- use the ``~`` to return the same ``SBool`` subtype but of the opposite truthiness
+
+  - Python's ``not`` operator always returns a ``bool``
+
+- constants ``TRUTH`` and ``LIE`` are the unique truthy and falsy ``SBool`` values
+
+Flavored Booleans
+~~~~~~~~~~~~~~~~~
+
+- functions ``truthy`` and ``falsy`` take any hashable value called its flavor
+- they return the unique truthy or falsy ``FBool`` respectively of that flavor
+
+Truthy_Falsy Booleans
+~~~~~~~~~~~~~~~~~~~~~
+
+- use ``TF_Booleans = T_Bool | F_Bool | TF_Bool`` only as a type
+- directly use ``T_Bool``, ``F_Bool``, ``TF_Bool`` as the type constructors
+- constants ``ALWAYS`` and ``Never`` are the unique ``TS_Bool`` truthy and falsy values
+
+  - but they are distinct subtypes of ``TS_Bool``
+
+    - for ``TS_Bool`` we have
+
+      - ``type(ALWAYS) is T_Bool``
+      - ``type(NEVER) is F_Bool``
+
+    - while for ``bool`` we have
+
+      - ``type(True) is bool``
+      - ``type(False) is bool``

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "pythonic-fp-booleans"
-version = "3.0.0"
+version = "3.0.1"
 readme = "README.rst"
 requires-python = ">=3.13"
 license = { file = "LICENSE" }
@@ -42,9 +42,7 @@ build-backend = "flit_core.buildapi"
 name = "pythonic_fp.booleans"
 
 [tool.mypy]
-enable_incomplete_feature = "NewGenericSyntax"
 explicit_package_bases = true
-implicit_reexport = false
 local_partial_types = true
 namespace_packages = true
 warn_redundant_casts = true
@@ -70,7 +68,10 @@ target-version = "py313"
 docstring-quotes = "double"
 
 [tool.ruff.lint.per-file-ignores]
-"tests/*" = ["C901"]
+"tests/**/*.py" = [
+  "E731",
+  "C901",
+]
 "**/*.py" = ["E741"]
 
 [tool.ruff.format]

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/src/pythonic_fp/booleans/__init__.py

@@ -14,7 +14,7 @@
 
 """
 Subtypable Boolean Class Hierarchy
-==================================
+----------------------------------
 
 .. graphviz::
 

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/src/pythonic_fp/booleans/flavored.py

@@ -13,14 +13,14 @@
 # limitations under the License.
 
 """
-.. admonition:: Class Favored Booleans: ``F_Bool``.
+.. admonition:: Class Favored Booleans
 
     When different flavors of the truth matter. Each ``FBool`` is
     an ``SBool`` subtype corresponds to a hashable value
     called its flavor.
 
     .. warning::
-        
+
         Combining ``FBool`` instances of different flavors
         with bitwise operators will just result in an ``SBool``.
 
@@ -59,10 +59,11 @@ class FBool(SBool):
         :param witness: Determines truthiness of the ``FBool`` instance returned.
         :param flavor: The ``flavor`` of ``FBool`` to created.
         :returns: The truthy or falsy ``FBool`` instance of a particular ``flavor``.
+
         """
         if witness:
             if flavor not in cls._truthy_dict:
-                with cls._truthy_lock:
+                with cls._truthy_dict_lock:
                     if flavor not in cls._truthy_dict:
                         cls._truthy_dict[flavor] = super(SBool, cls).__new__(cls, True)
             return cls._truthy_dict[flavor]
@@ -116,6 +117,7 @@ class FBool(SBool):
     def flavor(self) -> Hashable:
         """
         :returns: The flavor of the FBool.
+
         """
         return self._flavor
 
@@ -124,6 +126,7 @@ def truthy(flavor: Hashable) -> FBool:
     """
     :param flavor: Hashable value to determine which singleton ``flavor`` to return.
     :returns: The truthy singleton of a particular ``flavor``.
+
     """
     return FBool(True, flavor)
 
@@ -132,5 +135,6 @@ def falsy(flavor: Hashable) -> FBool:
     """
     :param flavor: Hashable value to determine which singleton ``flavor`` to return.
     :returns: The falsy singleton of a particular ``flavor``.
+
     """
     return FBool(False, flavor)

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/src/pythonic_fp/booleans/subtypable.py

@@ -13,25 +13,31 @@
 # limitations under the License.
 
 """
-**Subtypable Boolean.**
-
-Like Python's built in bool, class ``SBool`` is a subclass of int.
-Unlike bool, this version can be further subclassed.
-
-This type and its subtypes can also do (non-shortcut) Boolean logic
-using Python bitwise operators.
-
-+-------------------+--------+------------+
-| Boolean operation | symbol | dunder     |
-+===================+========+============+
-|       not         | ``~``  | __invert__ |
-+-------------------+--------+------------+
-|       and         | ``&``  | __and__    |
-+-------------------+--------+------------+
-|       or          | ``|``  | __or__     |
-+-------------------+--------+------------+
-|       xor         | ``^``  | __xor__    |
-+-------------------+--------+------------+
+.. admonition:: Subtypable Boolean
+
+    Like Python's built in bool, class ``SBool`` is a subclass of int.
+    Unlike bool, this version can be further subclassed.
+
+    This type and its subtypes can also do (non-shortcut) Boolean logic
+    using Python bitwise operators.
+
+    +-------------------+--------+------------+
+    | Boolean operation | symbol | dunder     |
+    +===================+========+============+
+    |       not         | ``~``  | __invert__ |
+    +-------------------+--------+------------+
+    |       and         | ``&``  | __and__    |
+    +-------------------+--------+------------+
+    |       or          | ``|``  | __or__     |
+    +-------------------+--------+------------+
+    |       xor         | ``^``  | __xor__    |
+    +-------------------+--------+------------+
+
+
+    While compatible with Python  short-cut logic. Unfortunately,
+    the ``not`` operator always returns a ``bool``. Use the
+    bitwise ``~`` operator to return an opposite ``SBool``
+    class or subclass.
 
 .. note::
 
@@ -41,10 +47,6 @@ using Python bitwise operators.
     least upper bound in the inheritance graph of the classes of
     the two arguments.
 
-While compatible with Python  short-cut logic. Unfortunately, the
-``not`` operator always returns a ``bool``. Use the bitwise ``~``
-operator to return an opposite ``SBool`` class or subclass.
-
 .. warning::
 
    The "bitwise" operators can raise ``TypeError`` exceptions

{pythonic_fp_booleans-3.0.0 → pythonic_fp_booleans-3.0.1}/src/pythonic_fp/booleans/truthy_falsy.py

@@ -13,25 +13,30 @@
 # limitations under the License.
 
 """
-**Class TF_Bool**
+.. admonition:: Truthy-Falsy Booleans
 
-Subclass of ``SBool`` whose truthy values and falsy values are
-different distinct singleton subtypes.
+    A Boolean implementation whose distinct truthy and falsy
+    values are distinct singleton subclasses, not just
+    distinct singleton values.
 
-This type can also do (non-shortcut) Boolean logic using Python
-bitwise operators.
+    A subtype of ``SBool``.
 
-----
+    .. tip::
 
-**Class T_Bool**
+        Logically combine these using Python's bitwise operators.
 
-The subtype of ``TF_Bool`` which is always truthy.
+    .. warning::
 
-----
+        Although these datastructures are completely compatible
+        with Python shortcut evaluation, care needs to be taken when
+        using them with the ``and``, ``or``, and ``not`` builtins.
 
-**Class F_Bool**
+        For example, ``~ALWAYS is NEVER`` but ``not ALWAYS is False``
+        because ``ALWAYS`` is truthy.
+
+        Similarly, ``(ALWAYS and False) is False`` while
+        ``(ALWAYS or False) is ALWAYS``.
 
-The subtype of ``TF_Bool`` which is always falsy.
 """
 
 import threading
@@ -58,6 +63,7 @@ class TF_Bool(SBool):
         :param witness: Determines which subtype, ``T_Bool`` or ``F_Bool`` is returned.
         :param flavor: Ignored parameter, only two flavors, one truthy and one falsy.
         :returns: Either The singleton truthy or singleton falsy subtypes.
+
         """
         if witness:
             return T_Bool()
@@ -97,6 +103,12 @@ class TF_Bool(SBool):
 
 @final
 class T_Bool(TF_Bool):
+    """
+    .. admonition:: The subtype of ``TF_Bool`` which is always truthy
+
+        A distinct type from F_Bool. A singleton value.
+
+    """
     _truthy: 'ClassVar[T_Bool | NoValue]' = _novalue
     _lock: ClassVar[threading.Lock] = threading.Lock()
 
@@ -122,6 +134,12 @@ class T_Bool(TF_Bool):
 
 @final
 class F_Bool(TF_Bool):
+    """
+    .. admonition:: The subtype of ``TF_Bool`` which is always falsy.
+
+        A distinct type from T_Bool. A singleton value.
+
+    """
     _falsy: 'ClassVar[F_Bool | NoValue]' = _novalue
     _lock: ClassVar[threading.Lock] = threading.Lock()
 
@@ -132,6 +150,7 @@ class F_Bool(TF_Bool):
         :param witness: Parameter ignored, an ``F_Bool`` is always falsy.
         :param flavor: Parameter ignored, only one falsy "flavor".
         :returns: The falsy ``F_Bool`` singleton instance.
+
         """
         if cls._falsy is _novalue:
             with cls._lock: