Docs

Author: sobolevn

docs/conf.py

@@ -76,7 +76,7 @@ def _get_project_meta():
 
 # Set `typing.TYPE_CHECKING` to `True`:
 # https://pypi.org/project/sphinx-autodoc-typehints/
-set_type_checking_flag = True
+set_type_checking_flag = False
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']

docs/index.rst

@@ -25,8 +25,8 @@ Contents
 
   pages/maybe.rst
   pages/result.rst
-  pages/context.rst
   pages/io.rst
+  pages/context.rst
 
 .. toctree::
   :maxdepth: 2

docs/pages/io.rst

@@ -317,8 +317,11 @@ Once applied, it transforms the return type to be ``IOResultE``:
 Use for impure operations that might fail.
 
 
+Helpers
+-------
+
 io_squash
----------
+~~~~~~~~~
 
 This function allows to squash several ``IO`` containers together.
 
@@ -348,7 +351,7 @@ We support up to 9 typed parameters to this function.
 .. _unsafe_perform_io:
 
 unsafe_perform_io
------------------
+~~~~~~~~~~~~~~~~~
 
 Sometimes you really need to get the raw value from ``IO`` container.
 For example:

docs/pages/maybe.rst

@@ -91,8 +91,18 @@ It looks way uglier and can grow even more uglier and complex
 when new logic will be introduced.
 
 
-@maybe decorator
-----------------
+Decorators
+----------
+
+Limitations
+~~~~~~~~~~~
+
+Typing will only work correctly
+if :ref:`decorator_plugin <type-safety>` is used.
+This happens due to `mypy issue <https://github.com/python/mypy/issues/3157>`_.
+
+maybe
+~~~~~
 
 Sometimes we have to deal with functions
 that dears to return ``Optional`` values!

docs/pages/result.rst

@@ -56,8 +56,18 @@ There are several useful alises for ``Result`` type with some common values:
   and ``ResultError`` at the same time.
 
 
+Decorators
+----------
+
+Limitations
+~~~~~~~~~~~
+
+Typing will only work correctly
+if :ref:`decorator_plugin <type-safety>` is used.
+This happens due to `mypy issue <https://github.com/python/mypy/issues/3157>`_.
+
 safe
-----
+~~~~
 
 :func:`safe <returns.functions.safe>` is used to convert
 regular functions that can throw exceptions to functions
@@ -79,13 +89,6 @@ Supports both async and regular functions.
   >>> str(divide(0))
   '<Failure: division by zero>'
 
-Limitations
-~~~~~~~~~~~
-
-Typing will only work correctly
-if :ref:`decorator_plugin <type-safety>` is used.
-This happens due to `mypy issue <https://github.com/python/mypy/issues/3157>`_.
-
 
 FAQ
 ---

returns/io.py

@@ -206,7 +206,7 @@ class IOResult(
     Explicit marker for impure function results that might fail.
 
     Definition
-    ----------
+    ~~~~~~~~~~
 
     We call it "marker" since once it is marked, it cannot be unmarked.
 
@@ -238,14 +238,14 @@ class IOResult(
       with :meth:`~IOResult.from_failed_io`
       and :meth:`IOResult.from_successful_io`
     - You can construct ``IOResult`` from ``Result`` values
-      with :meth:`~IOResult.__init__`
+      with :meth:`~IOResult.from_result`
 
     We also have a lot of utility methods for better function composition like:
 
     - :meth:`~IOResult.bind_result` to work
       with functions which return ``Result``
     - :meth:`~IOResult.from_typecast` to work with ``IO[Result[...]]`` values
-    - :meth:`~IOResult.lift` and `~IOResult.lift_result` to allow
+    - :meth:`~IOResult.lift` and :meth:`~IOResult.lift_result` to allow
       indirect function composition
       with regular and ``Result`` based functions.
 
@@ -254,7 +254,7 @@ class IOResult(
 
 
     Implementation
-    --------------
+    ~~~~~~~~~~~~~~
 
     This class contains all the methods that can be delegated to ``Result``.
     But, some methods have ``raise NotImplementedError`` which means