Skip to content

Commit

Permalink
docs: improved a bit
Browse files Browse the repository at this point in the history
  • Loading branch information
neithere committed Oct 21, 2023
1 parent d0e10a1 commit 595c355
Showing 1 changed file with 7 additions and 5 deletions.
12 changes: 7 additions & 5 deletions docs/source/the_story.rst
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,10 @@ Revival
-------

The author returned to his FOSS projects in early 2023. To his surprise, Argh
was all but dead and its niche as the "natural API" was not occupied by any
other project. It actually made sense to revive it. So a deep modernisation
and refactoring began.
was not dead at all and its niche as the "natural API" was not occupied by any
other project. It actually made sense to revive it.

A deep modernisation and refactoring began.

A number of pending issues were resolved and the last version to support
Python 2.x was released with a bunch of bugfixes.
Expand Down Expand Up @@ -109,10 +110,11 @@ A more complete example::

argh.dispatch_command(load)

The syntax is a subject to change but the essence is clear:
The syntax is subject to change but the essence is clear:

* as few surprises to the reader as possible;
* the function is declared in the normal way, like any other function;
* the function used as a CLI command is declared and callable in the normal
way, like any other function;
* type hints are used instead of ``@arg("foo", type=int)``
* additional metadata can be injected into type hints when necessary in a way
that won't confuse type checkers (like in FastAPI_, requires Python 3.9+);
Expand Down

0 comments on commit 595c355

Please sign in to comment.