Add some basic documentation for webkitpy scripts |
||
Issue descriptionMuch of the usage information is included in the --help section of each CLI script. However, I think it would be useful to have a landing page in https://chromium.googlesource.com/chromium/src/+/master/docs/ that gives people a bit of context on each script.
,
Jan 12 2017
Maybe just a list of each script and what it's used for? Do you think it's worth having this sort of landing page, or if someone is wondering what all the scripts do, would it be better for us to just say "look at the docstrings in each file"?
,
Jan 12 2017
I'm not sure if it's worth it. More documentation is better, but documentation can also grow out-of-date just like code. Using docstrings with the code is easier. This reminds me of: https://chromium.googlesource.com/external/github.com/luci/recipes-py/+/HEAD/doc/user_guide.md#Where_s-the-docs-on
,
Jan 12 2017
Agreed. Let's shelve this for now. |
||
►
Sign in to add a comment |
||
Comment 1 by qyears...@chromium.org
, Jan 11 2017