search

asyrjasalo / RESTinstance

Robot Framework library for RESTful JSON APIs
https://pypi.org/project/RESTinstance
GNU Lesser General Public License v3.0
206 stars 84 forks source link

Add some examples to keyword library #15

Closed jjwong closed 6 years ago

jjwong commented 6 years ago

Adding some simple examples, will add more examples in the future.

asyrjasalo commented 6 years ago

This is definitely better than the current state of the documentation 😄. Yeah, I have the documentation on the TODO list, but definitely could use some help with this with my current other schedules. Anyway, good job!

Resolved conflicts to current master and regenerated keyword documentation. I will "squash and merge" this PR to get rid of the revert commit in the history.

I will fix the comment indentation and header ("Example:" is fine instead of "Example Usage:") in master: These are mostly cosmetic things, but I think it does not hurt to follow the Robot Framework convention, e.g. https://github.com/robotframework/robotframework/blob/master/src/robot/libraries/BuiltIn.py.

Congrats for the first merged PR, I will credit you in the README. (I will check that RESTinstance_starter_project soon, and could probably link to it in README, if that is ok?)

asyrjasalo commented 6 years ago

There were some mistakes in the documentation, whether body is required argument or not, so I will fix these as well.