Giter Club home page Giter Club logo

Comments (6)

alecthomas avatar alecthomas commented on July 26, 2024

I agree. I basically never use them and always use Key().

I agree too that the docs could use some simplification. There's a lot of "theoretical" stuff on how the injector works, which is not really that helpful for using it at all.

from injector.

jstasiak avatar jstasiak commented on July 26, 2024

Cool. BTW how do you feel about having Sphinx-based documentation? I believe it's quite important to have some form of formal API specification - README shows some use cases but it'd be nice to have it described formally - right now one needs to read the source code in order to learn it.

from injector.

alecthomas avatar alecthomas commented on July 26, 2024

I would welcome Sphinx documentation. We could then host it on readthedocs which would be nice.

from injector.

jstasiak avatar jstasiak commented on July 26, 2024

Yup, that's what I was thinking about. I added a documentation stub to master, will get it to some usable state when I have some time.

from injector.

jstasiak avatar jstasiak commented on July 26, 2024

I can see the project is already configured on Read The Docs but the build is failing, presumably because the module is not being installed in the virtualenv there and build process can't find the module (https://readthedocs.org/builds/injector/819372/)

from injector.

alecthomas avatar alecthomas commented on July 26, 2024

I think it should be working now. I checked the "install in venv" checkbox.

from injector.

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.