New issue
Advanced search Search tips

Issue 678804 link

Starred by 1 user

Issue metadata

Status: WontFix
Owner:
Closed: Jan 2017
Cc:
Components:
EstimatedDays: ----
NextAction: ----
OS: ----
Pri: 3
Type: Bug



Sign in to add a comment

Add some basic documentation for webkitpy scripts

Project Member Reported by jeffcarp@chromium.org, Jan 5 2017

Issue description

Much 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.
 
Labels: Documentation
This is closely related to  bug 676670 , but more specifically this issue is to add a .md file in //docs, right?

What would be the scope of the doc? Would it be called something like //docs/blink_tools.md and be an overview of third_party/WebKit/Tools/Scripts?
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"?
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
Status: WontFix (was: Assigned)
Agreed. Let's shelve this for now.

Sign in to add a comment