document methods
ClosedPublic

Authored by garretraziel on Sep 3 2015, 11:49 AM.

Details

Summary

Document methods of classes that tests can inherit from.
I think that this makes all our utility functions documented - main.pm is documented,
needles and tests folder don't hold any utility functions and lib is documented
in this commit.

Test Plan

read through README.md and check that it makes sense.

Diff Detail

Repository
rOPENQATESTS os-autoinst-distri-fedora
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.
garretraziel retitled this revision from to document methods.Sep 3 2015, 11:49 AM
garretraziel updated this object.
garretraziel edited the test plan for this revision. (Show Details)
garretraziel added reviewers: jskladan, adamwill.
adamwill accepted this revision.Sep 3 2015, 3:47 PM

Tiny nitpick: the official way to spell openQA is like that, with a small o not a capital O.

Looks fine to me, thanks for this!

README.md
89

"login is as a root user" -> "login as root". Might be worth explaining that the point of it is it knows what TTY to use when, so you don't have to worry about that.

This revision is now accepted and ready to land.Sep 3 2015, 3:47 PM
This revision was automatically updated to reflect the committed changes.