katunilya/moona

Improve documentation

Closed this issue · 0 comments

katunilya commented

  • Repository improvements

    • Add license (MIT)
    • Add used git flow information to CONTRIBUTING.md
    • Add explanation for Makefile scripts in README.md or CONTRIBUTING.md
    • Fix Develop section in README.md (how to via Makefile)
    • Ignore .vscode folder
    • Add issue templates (Feature; Bug)
    • Add pull request template
    • Provide extensive explanation of core concepts in README.md

  • Improve pyproject.toml for pipy

    • Add readme link to pyproject.toml
    • Fix license in pyproject.toml
    • Add homepage to pyproject.toml
    • Add repository to pyproject.toml
    • Add documentation for pyproject.toml
    • Add keywords to pyproject.toml
    • Add classifiers to pyproject.toml (for pypi)

  • Improve documentation at github.io

    • Migrate to Starlette/FastAPI documentation theme. See ref.

  • Examples

    • Provide new "Hello, World!" example application
    • Provide "Calculator-Calca" example application (Fibonacci and Factorial calculation)
    • Provide "Lifespan" example application
    • Provide Maybe monad examples
    • Provide Future monad examples
    • Provide Result monad examples

  • Docstrings

    • Add more imports to mona/__init__.py
    • mona.asgi.create: Explain "lifespan" and "http" handling in ASGI root
    • mona.core.BaseContext: Fix LifespanContext to implemented
    • mona.core.LifespanContext.copy: Remove complete field from coping as there is no one
    • mona.core.HTTPContext: Fix docstring (it is for "http" scope and not replication of it)
    • mona.core.ContextError: Fix typing and relation to HTTPContext
    • mona.core.HTTPContext.create: Fix dot in Return section
    • mona.monads.core: Fix dot in Return section
    • mona.mondas.future.Future.__await__: Remove docstring as it is not required for dunder methods (?)
    • mona.core: group classes based on scope type
    • mona.monads.future.Future.identity: add example
    • Fix all docstrings 😄
  • State module
    • Add module-level docstring with explanation on State monad itself
    • Add detailed explanation of State class
    • Add detailed explanation of Right state class
    • Add detailed explanation of Wrong state class
    • Add detailed explanation of Error state class
    • Add detailed explanation of Final state class
    • Add better explanation for unpacks with example (and type hints)
    • Add better explanation for guards (accepts/rejects right/wrong/error/final) with examples (and type hints)
    • Add better explanation with examples for switchers (and type hints)
    • Find way to provide documentation for Type Aliases (or make them dedicated classes in hierarchy)
    • Fix return type hint for switch_to_final (now: Right[T]; should be: Final[T]
    • Add return value type hints for _wrapper functions inside guards (now: no hint)