Messing with config files for git presubmit check while cleaing

[pyutils.git] / docs / pyutils.rst

diff --git a/docs/pyutils.rst b/docs/pyutils.rst
index 0836f3149d834cbc5d583159aa47385a0019bd7f..4e8fdff0f1dec93b99375c2f2be67a89d21280b7 100644 (file)
--- a/docs/pyutils.rst
+++ b/docs/pyutils.rst
@@ -41,6 +41,11 @@ stable:
     - overrides: code decorator to mark and enforce method overrides.
     - pytz: Python timezones, used in date parser and utils.
 
+You can also install the wheel directly; the latest is checked in under: https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=dist;hb=HEAD.  To do so, download it, check that the MD5
+matches, and run::
+
+    pip install <filename.whl>
+
 Development
 -----------
 
@@ -50,7 +55,7 @@ Most code includes inline documentation and doctests.  I've tried to
 organize it into logical packages based on the code's functionality.
 Note that when words would collide with a Python standard library or
 reserved keyword I've used a 'z' at the end, e.g. 'collectionz'
-instead of 'collections', 'typez' instead of 'type', etc...
+instead of 'collections'.
 
 There's some example code that uses various features of this project checked
 in under `examples/ <https://wannabe.guru.org/gitweb/?p=pyutils.git;a=tree;f=examples;h=d9744bf2b171ba7a9ff21ae1d3862b673647fff4;hb=HEAD>`_ that you can check out.  See the `README <http://wannabe.guru.org/gitweb/?p=pyutils.git;a=blob_plain;f=examples/README;hb=HEAD>`__ in that directory for more information
@@ -83,6 +88,7 @@ To actually build the code (by which I mean type check it, lint it, package it,
 it, etc...) you need some other dependencies installed:
 
     - black: I use black to auto-format the code
+    - mypy: a Python type checker
     - coverage: used by the --coverage option of `run_tests.py`.
     - flake8: a Python linter
     - pylint: another Python linter
@@ -113,12 +119,12 @@ Subpackages
 
    pyutils.collectionz
    pyutils.compress
-   pyutils.datetimez
+   pyutils.datetimes
    pyutils.files
    pyutils.parallelize
    pyutils.search
    pyutils.security
-   pyutils.typez
+   pyutils.types
 
 Submodules
 ----------
@@ -2270,6 +2276,14 @@ during runtime) via Zookeeper (which is disabled by default).
    :undoc-members:
    :show-inheritance:
 
+pyutils.dataclass\_utils module
+-------------------------------
+
+.. automodule:: pyutils.dataclass_utils
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 pyutils.decorator\_utils module
 -------------------------------