diff --git a/casm/bset/clexwriter/_methods.py b/casm/bset/clexwriter/_methods.py index 53ffc0b..f0323cf 100644 --- a/casm/bset/clexwriter/_methods.py +++ b/casm/bset/clexwriter/_methods.py @@ -697,7 +697,21 @@ def _print_latex_site_bfuncs(builder): class ClexulatorWriter: - """Write Clexulator source files and related files""" + """Write Clexulator source files and related files + + The design is: + + - :func:`~casm.bset.write_clexulator` is the intended user interface for + writing Clexulator source files + - :class:`~casm.bset.clexwriter.ClexulatorWriter` implements the things that + all Clexulator writer versions need to do (write the C++ source files, + basis.json, equivalents_info.json, etc.) + - :class:`~casm.bset.clexwriter._methods.WriterV1Basic` or other classes + (WriterV1Diff, etc.) implements the specifics for a particular Clexulator + `version`, by specifying the template files and generating the variables used + by the templates. + + """ def __init__( self, diff --git a/casm/bset/clexwriter/_write_v1_basic.py b/casm/bset/clexwriter/_write_v1_basic.py index 24715f6..0099a05 100644 --- a/casm/bset/clexwriter/_write_v1_basic.py +++ b/casm/bset/clexwriter/_write_v1_basic.py @@ -21,7 +21,8 @@ class WriterV1Basic: - """Writes standard CASM v1 compatible Clexulator (no automatic differentiation)""" + """Generates the variables needed for the `v1.basic` Clexulator, the + standard CASM v1 compatible Clexulator (no automatic differentiation)""" @staticmethod def template_name():