Status: Accepted
Owner: ----
Labels: Type-Documentation Priority-Medium Target-1.2

New issue 73 by pekka.klarck: How to configure connections needs to be documented better
http://code.google.com/p/robotframework-sshlibrary/issues/detail?id=73

In earlier versions configuration was done at library import, when using Open Connection, or using Set Prompt, Set Timeout, Set Newline and Set Default Log Level configuration keywords. This was changed in 1.1 when these configuration keywords were deprecated and new Set Default Configuration and Set Client Configuration keywords were introduced. There are still some documentation issues related to this change:

1) Deprecation message in old keywords should mention both Set Client Configuration and Set Default Configuration as a new alternative. Currently it only shows the latter.

2) Set Client Configuration and Set Default Configuration keywords should have links to each others and to library importing and Open Connection. Also library import and Open Connection needs same links.

3) There could also be a separate section in library introduction about configuration. This might work better than explaining configuration in four different places (import, Open Connection, Set Client/Default Configuration). Then these places could just have rather short docs and links to the section in the introduction and possibly to each others.

--
You received this message because this project is configured to send all issue notifications to this address.
You may adjust your notification preferences at:
https://code.google.com/hosting/settings

--

--- You received this message because you are subscribed to the Google Groups "robotframework-commit" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
For more options, visit https://groups.google.com/groups/opt_out.


Reply via email to