From b245275733157a59fc3acf7fe116db09a144c701 Mon Sep 17 00:00:00 2001 From: "Alex A. Naanou" Date: Tue, 23 Aug 2016 18:42:38 +0300 Subject: [PATCH] working on docs.. Signed-off-by: Alex A. Naanou --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index 2a03004..d4e9db6 100644 --- a/README.md +++ b/README.md @@ -12,15 +12,12 @@ The Feature / Action couple is meta-programming library that helps with: Actions are an extension to the JavaScript object model tailored for a set of specific tasks. - -#### Goals: -- Provide a unified mechanism to define and manage user API's for - use in UI-hooks, keyboard mappings, scripting, ... etc. -- A means to generate configuration UI's -- A means to generate documentation +By design this tool-set promotes a _cooperative_ model and makes it +hard to change/modify existing signatures / _contracts_ in _extending_ +code. -#### Functionality: +### Functionality: - **Call _extended_ actions automatically** All actions (methods) in a chain are guaranteed to get called if the action is called. @@ -30,11 +27,12 @@ a set of specific tasks. - **Thread the return value down the call chain** The return value will get passed through all the actions in a chain before returning to the action caller. +- **Organise and apply actions to objects** - **Unified way to document actions** - **Introspection and inspection API** -#### Restrictions: +### Restrictions comparing to native JavaScript: - **No method shadowing** The _extending_ action can not "shadow" the _extended_ action in a non destructive manner (e.g. via a `throw`), all actions in a chain are @@ -52,9 +50,6 @@ a set of specific tasks. _extending_ actions are ignored - **Return `this` by default** -By design this tool-set promotes a _cooperative_ design and makes it -hard to change/modify existing signatures / _contracts_ in _extending_ -code. @@ -127,7 +122,7 @@ Root Action o---|---x .getDoc([, ..]) -> dict of action-name, doc - .a.getHandlerDocStr() + .getHandlerDocStr() -> formated string of action handlers .actions