diff options
| author | Jan Pokorný <jpokorny@redhat.com> | 2014-06-16 16:12:08 +0200 |
|---|---|---|
| committer | Jan Pokorný <jpokorny@redhat.com> | 2014-06-16 16:12:40 +0200 |
| commit | 2489b45814189739ad832aed32b13db693848207 (patch) | |
| tree | 75f9360c70071e54e4d7e6d255ade54ac6432707 /doc | |
| parent | e7cb18db3d544fb8eb7581616deb49ddb55b6497 (diff) | |
| download | clufter-2489b45814189739ad832aed32b13db693848207.tar.gz clufter-2489b45814189739ad832aed32b13db693848207.tar.xz clufter-2489b45814189739ad832aed32b13db693848207.zip | |
doc/HACKING: add some bits about "command" entity
Signed-off-by: Jan Pokorný <jpokorny@redhat.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING | 12 |
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/HACKING b/doc/HACKING index de382e0..65fe57e 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -42,9 +42,21 @@ relationships: - 'composite' denotes multi-channel interchange format (consisting of atomic ones) + Command ------- +Figuring out the options/arguments for use to enter at the command line +is heavily based on introspection of the function being decorated by +`Command.deco`. The explanation for the help screen is supposed to +be encoded directly in the respective docstring as per the existing +samples. For DRY, you can also defer to another function (to be called +before the body of the main command-driving one, likewise being passed +command context and the appropriate keyword arguments of all originally +passed at the function entry) defining the common arguments at the tail ++ utilizing them if suitable: this function is passed as `_common` (see +`commands.ccs2pcs.ccs2pcs_needle` +`filters.XMLFilter.command_common`). + Filter ------ |