Merge pull request #351 from pathunstrom/flags-docs

Adds a page documenting ppb.flags.
ppb · May 20, 2024 · 22f3eb0 · 22f3eb0
2 parents ef81cb4 + 4918ea0
commit 22f3eb0
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 4 deletions.
diff --git a/docs/reference/flags.rst b/docs/reference/flags.rst
@@ -0,0 +1,21 @@
+=============
+Flags
+=============
+
+.. automodule:: ppb.flags
+
+--------------
+Base classes
+--------------
+
+This is the base class for defining new flags.
+
+.. autoclass:: ppb.flags.Flag
+
+----------------
+Metaclasses
+----------------
+
+The metaclass that makes the type hinting of flags possible.
+
+.. autoclass:: ppb.flags.FlagMeta
diff --git a/docs/reference/index.rst b/docs/reference/index.rst
@@ -30,4 +30,5 @@ decisions are made, see the :doc:`/discussion/index` section.
    directions
    deprecations
    system
+   flags
    features/index
diff --git a/src/ppb/flags.py b/src/ppb/flags.py
@@ -1,17 +1,18 @@
 """
 ppb.flags contains singletons to communicate various things.
 
-Flags should be used like None and ... (Ellipsis):
-* compare against using `is`
+Flags should be used like ``None`` and ``...`` (Ellipsis):
+
+* compare against using ``is``
 * Do not instantiate new instances
 
-New flags can simply be defined by:
+New flags can simply be defined by::
 
     class MyFlag(Flag):
         "This is a flag to indicate a thing."
 
 
-New classes of flags (eg mouse buttons) can be defined as:
+New classes of flags (eg mouse buttons) can be defined as::
 
     class MyFlagType(Flag, abstract=True):
         "A group of indicators"