Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Create/add/update documentation with argument list

See original GitHub issue

Hey,

I’ve looked hard, and I know some of them are new (e.g. https://github.com/jmathai/elodie/issues/104#issuecomment-209246169 ), but some comprehensive documentation for arguments would be useful (i.e. --debug --destination --source --trash)

I’ll reference https://github.com/jmathai/elodie/issues/105 for your convenience

Hope this is useful

Regards

Issue Analytics

State:
Created 7 years ago
Comments:7 (4 by maintainers)

Top GitHub Comments

1reaction

jmathaicommented, Sep 14, 2016

Included the output from the command line program into the Readme.

https://github.com/jmathai/elodie/blob/master/Readme.md#usage-instructions

0reactions

ldexterldesigncommented, Apr 13, 2016

Here are a few documentation generators I have noted:

I almost had the need to use one a few years ago to document a front-end pattern library I was building for a company, but it didn’t materialise - still curious about how they work

Perhaps @noonat has found something better since…?

I will research them sometime…

Regards

Top Results From Across the Web

argparse — Parser for command-line options, arguments and ...

See the documentation for add_argument() for details. args - List of strings to parse. The default is taken from sys.argv . namespace -...

Argument List (GNU Emacs Lisp Reference Manual)

Our simple sample function, (lambda (a b c) (+ a b c)) , specifies three argument variables, so it must be called with...

Arguments — Click Documentation (7.x)

Basic Arguments¶. The most basic option is a simple string argument of one value. If no type is provided, the type of the...

The arguments object - JavaScript - MDN Web Docs - Mozilla

arguments is an Array-like object accessible inside functions that contains ... It returns a string list using each argument in the list:.

Start-Process (Microsoft.PowerShell.Management)

-ArgumentList. Specifies parameters or parameter values to use when this cmdlet starts the process. Arguments can be accepted as a single string with...