[Feat] Docstring documentation for Python SDK - Githubissues

codenotary / immudb-py

immudb Python SDK

Apache License 2.0

45 stars 7 forks source link

[Feat] Docstring documentation for Python SDK #51

Closed tomekkolo closed 2 years ago

tomekkolo commented 2 years ago

Description Document Python SDK so it is easily usable with any IDE and intelli sense. How documentation should look like ? Python docstrings

Action Items

[ ] every public function has description including arguments, return values, errors etc.
[ ] every public class has description including arguments, return values, errors etc.
[ ] every non trivial function (or with lot of arguments) has short code sample in description