search

lk-geimfari / mimesis

Mimesis is a robust data generator for Python that can produce a wide range of fake data in multiple languages.
https://mimesis.name
MIT License
4.39k stars 330 forks source link

Use type hints in docs #259

Closed sobolevn closed 6 years ago

sobolevn commented 6 years ago

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.

simongoricar commented 6 years ago

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

sobolevn commented 6 years ago

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

simongoricar commented 6 years ago

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?

sobolevn commented 6 years ago

@lk-geimfari could you please help @DefaltSimon ?

lk-geimfari commented 6 years ago

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

simongoricar commented 6 years ago

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

lk-geimfari commented 6 years ago

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

lk-geimfari commented 6 years ago

@sobolevn It's done!