Skip to content

Commit

Permalink
...
Browse files Browse the repository at this point in the history
  • Loading branch information
ken-morel committed Jun 8, 2024
1 parent 230da23 commit cc2f66e
Show file tree
Hide file tree
Showing 3 changed files with 775 additions and 6,477 deletions.
32 changes: 30 additions & 2 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,36 @@ Welcome to pyoload v|version| documentation!
:alt: Hit count


welcome to pyoloads documentation, a python module for typechecking and
casting of complex to simple datatypes.
Hy pythonista, here is `pyoload`, what is?

A python module to integrate function arguments typechecking, and multiple
dispatching in python.

It uses the beauty and ease of use of decorators and python scopes to provide
an easy to use tool. here some quick examples.


```python
from pyoload import *
@annotate
def greater_than(a: int | float, b: int | float) -> bool:
return a > b
@multimethod
def foo(a, b=3, c: int = 5):
...
@multimethod
def foo(a: int, b: Cast(str)):
...
@multimethod
def foo(a) -> Cast(str):
return repr(a)
foo(4)
```


* :ref:`genindex`
Expand Down
13 changes: 13 additions & 0 deletions docs/installation.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
==================================================
Installation
==================================================

Not sure that needed a topic..., but this is the installation manual:

--------------------------------------------------
using pip
--------------------------------------------------

^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
from pypi
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Loading

0 comments on commit cc2f66e

Please sign in to comment.