GithubHelp home page GithubHelp logo

Required docs [Sphinx] about mimesis HOT 7 CLOSED

lk-geimfari avatar lk-geimfari commented on May 12, 2024
Required docs [Sphinx]

from mimesis.

Comments (7)

Battleroid avatar Battleroid commented on May 12, 2024 1

If it's alright with you, I'll give it a shot.

from mimesis.

Battleroid avatar Battleroid commented on May 12, 2024 1

I'm going through and trying to put together the Sphinx documentation now. Some of the docstrings have very minor formatting issues so I'll fix those as well if that's ok.

from mimesis.

Battleroid avatar Battleroid commented on May 12, 2024 1

Submitted pull request #29

from mimesis.

lk-geimfari avatar lk-geimfari commented on May 12, 2024

@Battleroid Thank you! Let me know about your final decision, please.

from mimesis.

arpit1997 avatar arpit1997 commented on May 12, 2024

I would like to do these work. Let me know that if there is any need of updating the docStrings or not. One more question about the example, do you want examples included in the docs or not? 🚀

from mimesis.

lk-geimfari avatar lk-geimfari commented on May 12, 2024

@arpit1997 I think that docstrings is actual and recently updated. Yes, it would be good to include examples in the documentation. Everything should be in the 'docs' folder (root of repository). Thanks!

from mimesis.

lk-geimfari avatar lk-geimfari commented on May 12, 2024

@Battleroid Sorry for issues in docstrings. Thank you for your contribution!

from mimesis.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.