function/module documentation with usage examples

[PragTob]

The documentation for wallaby is improvable :)

Imo Browser and Query are the most important modules.

What should good documentation have imo?

• a short description of the general purpose of the function
• a longer description with edge cases etc. if needed
• usage example (!!!) (ideally doctests, but I think that's hard/not practical for us) so that it's easy for people to get into

Something that I find myself looking up constantly when working with wallaby is what queries like button/text_field match on e.g. id, name, text... whatever. That information would be great to have documented as I don't believe everyone enjoys reading the compiled xpath queries :D

I especially think Query needs some love:

To see how far along we are, we have inch_ex.

We can also see, if we ant to exclude further modules and functions from the documentation.

[bernardobelchior]

+1

[keathley]

I'm not sure if I'll have time to go through and submit PRs for these but I'm available if you need to know about each query and what it will select on :+1:

[PragTob]

Minus the usage example a lot of this is already implemented on master :)