docstring updates

This commit is contained in:
jan 2023-10-15 18:31:58 -07:00
parent 2229ee5d25
commit 668d4b5d8b

View File

@ -1,7 +1,7 @@
""" """
masque 2D CAD library masque 2D CAD library
masque is an attempt to make a relatively small library for designing lithography masque is an attempt to make a relatively compact library for designing lithography
masks. The general idea is to implement something resembling the GDSII and OASIS file-formats, masks. The general idea is to implement something resembling the GDSII and OASIS file-formats,
but with some additional vectorized element types (eg. ellipses, not just polygons), and the but with some additional vectorized element types (eg. ellipses, not just polygons), and the
ability to interface with multiple file formats. ability to interface with multiple file formats.
@ -20,10 +20,10 @@
NOTES ON INTERNALS NOTES ON INTERNALS
========================== ==========================
- Many of `masque`'s classes make use of `__slots__` to make them faster / smaller. - Many of `masque`'s classes make use of `__slots__` to make them faster / smaller.
Since `__slots__` doesn't play well with multiple inheritance, the `masque.utils.AutoSlots` Since `__slots__` doesn't play well with multiple inheritance, often they are left
metaclass is used to auto-generate slots based on superclass type annotations. empty for superclasses and it is the subclass's responsibility to set them correctly.
- File I/O submodules are imported by `masque.file` to avoid creating hard dependencies on - File I/O submodules are not imported by `masque.file` to avoid creating hard dependencies
external file-format reader/writers on external file-format reader/writers
""" """