Some more info about the typeclass/list cmd in docstring

This commit is contained in:
Griatch 2019-06-28 22:22:29 +02:00
parent 838c57e63b
commit 007c8fce92

View file

@ -1691,27 +1691,28 @@ class CmdTypeclass(COMMAND_DEFAULT_CLASS):
object - basically making this a new clean object. object - basically making this a new clean object.
force - change to the typeclass also if the object force - change to the typeclass also if the object
already has a typeclass of the same name. already has a typeclass of the same name.
list - show available typeclasses. list - show available typeclasses. Only typeclasses in modules actually
imported or used from somewhere in the code will show up here
(those typeclasses are still available if you know the path)
Example: Example:
type button = examples.red_button.RedButton type button = examples.red_button.RedButton
If the typeclass_path is not given, the current object's If the typeclass_path is not given, the current object's typeclass is
typeclass is assumed. assumed.
View or set an object's typeclass. If setting, the creation hooks View or set an object's typeclass. If setting, the creation hooks of the
of the new typeclass will be run on the object. If you have new typeclass will be run on the object. If you have clashing properties on
clashing properties on the old class, use /reset. By default you the old class, use /reset. By default you are protected from changing to a
are protected from changing to a typeclass of the same name as the typeclass of the same name as the one you already have - use /force to
one you already have - use /force to override this protection. override this protection.
The given typeclass must be identified by its location using The given typeclass must be identified by its location using python
python dot-notation pointing to the correct module and class. If dot-notation pointing to the correct module and class. If no typeclass is
no typeclass is given (or a wrong typeclass is given). Errors in given (or a wrong typeclass is given). Errors in the path or new typeclass
the path or new typeclass will lead to the old typeclass being will lead to the old typeclass being kept. The location of the typeclass
kept. The location of the typeclass module is searched from the module is searched from the default typeclass directory, as defined in the
default typeclass directory, as defined in the server settings. server settings.
""" """