improve docs

This commit is contained in:
Jan Petykiewicz 2023-01-12 23:05:45 -08:00 committed by jan
parent 5f35e8c8e3
commit a4f89e6f48

View File

@ -33,6 +33,7 @@ LL = TypeVar('LL', bound='LazyLibrary')
class Library(Mapping[str, Pattern], metaclass=ABCMeta): class Library(Mapping[str, Pattern], metaclass=ABCMeta):
# inherited abstract functions
#def __getitem__(self, key: str) -> 'Pattern': #def __getitem__(self, key: str) -> 'Pattern':
#def __iter__(self) -> Iterator[str]: #def __iter__(self) -> Iterator[str]:
#def __len__(self) -> int: #def __len__(self) -> int:
@ -203,7 +204,7 @@ class Library(Mapping[str, Pattern], metaclass=ABCMeta):
quiet: If `True`, suppress log messages. quiet: If `True`, suppress log messages.
Returns: Returns:
Unique name for this library. Name, unique within this library.
""" """
if sanitize: if sanitize:
# Remove invalid characters # Remove invalid characters
@ -252,6 +253,10 @@ class MutableLibrary(Library, metaclass=ABCMeta):
@abstractmethod @abstractmethod
def __setitem__(self, key: str, value: VVV) -> None: def __setitem__(self, key: str, value: VVV) -> None:
pass pass
# inherited abstract functions
#def __getitem__(self, key: str) -> 'Pattern':
#def __iter__(self) -> Iterator[str]:
#def __len__(self) -> int:
@abstractmethod @abstractmethod
def __delitem__(self, key: str) -> None: def __delitem__(self, key: str) -> None: