Giter VIP home page Giter VIP logo

Comments (9)

keleshev avatar keleshev commented on July 30, 2024

From docs:

Note when docopt is set to automatically handle -h, --help and --version options, you still need to mention them in doc. Also for your users to know about them.

Anyway, thanks for you thorough feedback with several issues, this probably shows that the documentation is not clear enough. What do you think of docopt overall?

from docopt.

RonnyPfannschmidt avatar RonnyPfannschmidt commented on July 30, 2024

could work, still messing around

sub-commands need some more stuff to get more convenient wrt describing and referring to them

its impossible to scale up to larger tools, but seems fine for scripts and medium sized things

from docopt.

keleshev avatar keleshev commented on July 30, 2024

actually docopt was done to scale, take a look at git_example.py:

https://github.com/halst/docopt/blob/master/examples/git_example.py

API ideas welcome.

from docopt.

RonnyPfannschmidt avatar RonnyPfannschmidt commented on July 30, 2024

that’s only medium sized, by large i mean something like the complete interface of something like git/hg
including the possibility to extend it with new commands

i'd avoid to go that way for utterly insane complexity as reason

from docopt.

keleshev avatar keleshev commented on July 30, 2024

Actually docopt is going that way :-) but it will remain as simple as it is. One idea is to have a decorator @command so that you could specify usage patterns in docstrings for each of you internal functions. One that matches invocation will be executed. What do you think of that?

from docopt.

RonnyPfannschmidt avatar RonnyPfannschmidt commented on July 30, 2024

sounds interesting, currently i don't have a big enough use-case to try and see if its any good

from docopt.

RonnyPfannschmidt avatar RonnyPfannschmidt commented on July 30, 2024

but in a few months i'll write a cli for a scm abstraction tool, then i might have a use case

from docopt.

keleshev avatar keleshev commented on July 30, 2024

Let me know! I have not build any complex CLI (as git/hg), so I simply don't know what awaits someone when using docopt.

from docopt.

keleshev avatar keleshev commented on July 30, 2024

Updated docs: 77dc0ca

from docopt.

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.