Skip to content

Commit 8891b34

Browse files
authored
Add chapter to README.rst where to find docs about extending. (#1031)
1 parent 51afed6 commit 8891b34

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

README.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,6 +156,19 @@ See the demo for more examples that you can also execute on your own
156156
machine. For more information about Robot Framework test data syntax in
157157
general see the `Robot Framework User Guide`_.
158158

159+
Extending SeleniumLibrary
160+
-------------------------
161+
Before creating your own library which extends the ``SeleniumLibrary``, please consider would
162+
the extension be also useful also for general usage. If it could be useful also for general
163+
usage, please create a new issue describing the enhancement request and even better if the
164+
issue is backed up the a pull request.
165+
166+
If the enhancement is not generally useful, example solution is domain specific, then the
167+
SeleniumLibrary offers a public API which can be used to build own libraries. All keyword
168+
methods are available in the public API. There are also generally useful methods and attributes
169+
available, which are useful for creating new libraries. Please see `extending documentation`_
170+
for more details about the available methods and for examples how the library can be extended.
171+
159172
Support
160173
-------
161174

@@ -243,6 +256,7 @@ project.
243256
.. _Robot Framework User Guide: http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html
244257
.. _Robot Framework installation instructions: https://github.com/robotframework/robotframework/blob/master/INSTALL.rst
245258
.. _robotframework-users: http://groups.google.com/group/robotframework-users
259+
.. _extending documentation: https://github.com/robotframework/SeleniumLibrary/blob/master/docs/extending/EXTENDING_SELENIUMLIBRARY.rst
246260
.. _Slack community: https://robotframework-slack-invite.herokuapp.com
247261
.. _issue tracker: https://github.com/robotframework/SeleniumLibrary/issues
248262
.. _Other support forums: http://robotframework.org/#support

0 commit comments

Comments
 (0)