diff options
| -rw-r--r-- | click/formatting.py | 2 | ||||
| -rw-r--r-- | docs/complex.rst | 6 | ||||
| -rw-r--r-- | docs/why.rst | 8 |
3 files changed, 8 insertions, 8 deletions
diff --git a/click/formatting.py b/click/formatting.py index f018432..eedac69 100644 --- a/click/formatting.py +++ b/click/formatting.py @@ -203,7 +203,7 @@ class HelpFormatter(object): """Helpful context manager that writes a paragraph, a heading and the indents. - :param name: the section name taht is written as heading. + :param name: the section name that is written as heading. """ self.write_paragraph() self.write_heading(name) diff --git a/docs/complex.rst b/docs/complex.rst index ebf1efb..30a4d93 100644 --- a/docs/complex.rst +++ b/docs/complex.rst @@ -12,7 +12,7 @@ realized that it provides a command line utility. But so does Celery for instance. So when using Celery with Django there are two tools that need to interact with each other and be cross configured. -In a theoretical world of two separate Click command line utilities they +In a theoretical world of two separate click command line utilities they can solve this problem by nesting one inside the other. For instance the web framework could also load the commands for the message queue framework. @@ -26,7 +26,7 @@ and the calling convention. Contexts ```````` -Whenever a Click command is executed a :class:`Context` object is created +Whenever a click command is executed a :class:`Context` object is created which holds state for this particular invocation. For instance it remembers parsed parameters, what command created it, which resources need to be cleaned up at the end of the function and so forth. It also holds @@ -46,7 +46,7 @@ complex applications it comes in handy. This brings us to the next point. Calling Convention `````````````````` -When a Click command callback is executed it's passed all the non hidden +When a click command callback is executed it's passed all the non hidden parameters as keyword arguments. Notably absent is the context. However a callback can opt-into being passed the context object by marking itself with :func:`pass_context`. diff --git a/docs/why.rst b/docs/why.rst index 8daf719..e0c8c39 100644 --- a/docs/why.rst +++ b/docs/why.rst @@ -71,7 +71,7 @@ Python library that tries to aim for composability of applications that goes beyond what the system itself supports. Docopt for instance acts by parsing your help pages and then parsing -according do those rules. The side effect of this is that docopt is quite +according to those rules. The side effect of this is that docopt is quite rigid in how it handles the command line interface. The upside of docopt is that it gives you strong control over your help page, the downside is that due to that it cannot rewrap your output for the current terminal @@ -85,10 +85,10 @@ support dispatching to subcommands, it for instance does not directly support any kind of automatic subcommand enumeration based on what's available or it does not enforce subcommands to work in a consistent way. -This is fine, but it's different from how Click wants to work. Click aims +This is fine, but it's different from how click wants to work. Click aims to support fully composable command line user interfaces by doing this: -- click does not just parse, it also dispatches to the appropriate code +- click does not just parse, it also dispatches to the appropriate code. - click has a strong concept of an invocation context that allows subcommands to respond to data from the parent command. - click has strong information available for all parameters and commands @@ -98,7 +98,7 @@ to support fully composable command line user interfaces by doing this: consistent error messages if something goes wrong. A subcommand written by a different developer will not suddenly die with a different error messsage because it's manually handled. -- click has enough meta information available for it's whole program +- click has enough meta information available for its whole program that it can evolve over time to improve the user experience without forcing developers to adjust their programs. For instance if click decides to change how help pages are formatted, all click programs |