yanne / api-test

0 stars 0 forks source link

Move library usage example to keyword documentation #61

Closed yanne closed 10 years ago

yanne commented 10 years ago

None

This issue was originally opened at Google Code on Oct 17, 2012.

yanne commented 10 years ago

Original comment by robotframework@gmail.com on Jul 31, 2013.

Examples actually are available as a separate download. They could still be enhanced, though:

1) Examples should have simple wiki page. 2) We should consider combining example test and resource to single file. After this the file could be linked from the wiki directly and no download would be needed.

yanne commented 10 years ago

Original comment by anssi.sy...@eficode.com on Sep 16, 2013.

What is done so far:

1) All wiki pages, particularly the installation instructions, are updated. 2) README is updated and now has links to the respective wiki pages. 3) All keywords are documented and have at least one or even more examples. 4) The existing independent examples (in the source distribution under 'examples/', or downloadable as 'examples.zip') were OS dependent so they are now mostly removed. A single example was left there, which does not use Robot resource files anymore and will pass both on Linux and Windows.

yanne commented 10 years ago

Original comment by pekka.klarck on Oct 15, 2013.

In the end we decided it's more important to have a good example along with other library/keyword documentation. After adding such example, the external example didn't provide much benefits and was removed.

The latest version of the new example is visible here:

https://robotframework-sshlibrary.googlecode.com/git-history/master/doc/SSHLibrary.html#Example