Mimesis: Use type hints in docs

Created on 22 Oct 2017  路  8Comments  路  Source: lk-geimfari/mimesis

Connected to https://github.com/lk-geimfari/mimesis/issues/258

There is a plugin for sphinx to grab type hints into autodocs: https://github.com/agronholm/sphinx-autodoc-typehints

I guess it should be used.

enhancement help wanted

Most helpful comment

@sobolevn It's done!

All 8 comments

I'll try to make this work, if you don't mind :)

Make sure you are in sync with https://github.com/lk-geimfari/mimesis/pull/260

I have already made the necessary changes to convert :rtype: to type annotations and enable the sphinx extension, should I add annotations for parameters like in #260 as well?

@lk-geimfari could you please help @DefaltSimon ?

@DefaltSimon Yeah, sure. We work on type hints in type-hinting branch.

Sure, I'll submit a pull request to that branch when I finish builtins and the base mimesis directory.

@DefaltSimon Thanks for contributing! Don't forget to add yourself to contributors.md.

@sobolevn It's done!

Was this page helpful?
0 / 5 - 0 ratings

Related issues

lk-geimfari picture lk-geimfari  路  3Comments

lk-geimfari picture lk-geimfari  路  5Comments

jjgriff93 picture jjgriff93  路  5Comments

sobolevn picture sobolevn  路  6Comments

lk-geimfari picture lk-geimfari  路  3Comments