Structuring the documentation. - Githubissues

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

Structuring the documentation. #226

Closed lk-geimfari closed 6 years ago

lk-geimfari commented 7 years ago

We have some inconsistency in the documentation, we need to fix it.

What should be done?

[x] Move description of all basic features of Mimesis to index.rst.
[x] Add section Decorators with examples of using decorators from decorators.py.
[x] Add section Generate data by schema with examples of using Schema() from mimesis/schema.py.
[x] Add section Constants with examples of all available constants from mimesis/constants/.
[x] Add sections Utilities with examples of using functions from mimesis/utils.py.
[x] Add section Builtins Specific Providers with examples of using ones.

mish24 commented 6 years ago

@lk-geimfari I want to work on this for hacktoberfest. Anything I should remember for this?

lk-geimfari commented 6 years ago

@mish24 I have updates TODO list. Please, look at tasks.

ZamaSharik commented 6 years ago

@lk-geimfari I am on it. and would love to work on it.

lk-geimfari commented 6 years ago

@Sidsharik Yeah, sure! You're assigned. Thanks!

sotsugov commented 6 years ago

@lk-geimfari Hello, anything I can help with?

lk-geimfari commented 6 years ago

@sotsugov It's done! Thanks!