Join GitHub today
GitHub is home to over 50 million developers working together to host and review code, manage projects, and build software together.
Sign upGitHub is where the world builds software
Millions of developers and companies build, ship, and maintain their software on GitHub — the largest and most advanced development platform in the world.
Add Python script documentation to docs #21582
Comments
|
List of available programmatic options is clearly mentioned in embedding guide. |
|
@dstftw So why can't this in-code documentation be moved to a separate embedding Markdown file? |
Checklist
Description
For use in a python script, parameters are different than those listed in
README.mdfor command line usage. For example, inREADME.md:When trying to call in a standalone Python script importing
youtube_dl, the same functionality is passed in the'cookiefile'argument.Documentation on the translation between command line arguments and Python object instantiation arguments will help developers as opposed to searching through library source code.