search

dbrattli / Expression

Pragmatic functional programming for Python inspired by F#
https://expression.readthedocs.io
MIT License
424 stars 31 forks source link

Try docs #45

Closed bgrounds closed 2 years ago

bgrounds commented 2 years ago

Not sure if this is intentional, but the docs for the Try class are nearly identical to the docs for the Result class.

I would expect the source code reference for Try to show a type alias (Try = Result[TSource, Exception]) or sub-class definition.

https://cognitedata.github.io/Expression/expression/

dbrattli commented 2 years ago

Yes, the pdoc3 generator is not handling type aliases that well. We should consider moving the docs to sphinx.

dbrattli commented 2 years ago

This issue should now be fixed after moving docs to Jupyter Book and ReadTheDocs: https://expression.readthedocs.io/en/latest/reference/try.html