Documentation for typ ?

[Dirk Pranke]

Hi all,

Most of you probably are at least vaguely aware that telemetry_unittests and test-webkitpy are thin wrappers around the typ

library:

https://github.com/dpranke/typ.git.

Right now, the documentation for typ is thin-to-nonexistent. There's command-line help, and mostly it's a wrapper around

unitttest, so it's reasonably self-explanatory, but it does have a number of features unittest doesn't that aren't that well

documented, and I don't like code w/ no documentation.

But, I don't really want to write docs that aren't that useful to people, and you all are probably the people (outside of me)

that have used it the most, which isn't saying that much ;).

What sort of documentation would you like to see? Command-line usage? API reference documentation? Cookbook examples?

Fine the way it is?

Cheers,

-- Dirk

PS. To head off a question: I've also filed crbug.com/513804 to get a standalone mirror of typ.

[Dirk Pranke]

ping?

[zh...@google.com]

I may not be able to speak for the Telemetry team. But based on my past experience working with typ, I would like to see cookbook examples and explanations on how the public hooks are used, e.g., the ones declared in runner.Runner.__init__(). Thanks!

Best
-Zhen

[Nat Duca]

If nothing else, I'd love a basic 1,2,3 set of snippets that get you going with a typ-derived project. Eg name your test modules X_foo.py, then make a run_tests.py script taht includes blah.

[Dirk Pranke]

Sure, makes sense.