Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document how to extend the library #1007

Closed
pekkaklarck opened this issue Dec 1, 2017 · 4 comments
Closed

Document how to extend the library #1007

pekkaklarck opened this issue Dec 1, 2017 · 4 comments

Comments

@pekkaklarck
Copy link
Member

The new architecture in SL 3.0 (#771) is likely to break lot of external libraries using SL internally somehow. Explicitly exposing and documenting the public API (#882) helps, but we should still document different approaches how to interact with the library and how to safely extend it. Examples are going to be very valuable.

@pekkaklarck
Copy link
Member Author

pekkaklarck commented Dec 1, 2017

If you are a maintainer of a library that is broken due to the changes in SL 3.0, please report your problems here, on robotframework-users mailing list, or on Slack.

https://groups.google.com/group/robotframework-users
https://robotframework-slack-invite.herokuapp.com/

@aaltat aaltat added this to the v3.1.0 milestone Dec 3, 2017
@aaltat
Copy link
Contributor

aaltat commented Dec 3, 2017

There are many libraries which already extend the Selenium2Library in one way or other. It would be good to have links to point to other projects which go nicely together with SL. Like in #638

  1. How to extend the library by providing PR with GitHub. This is mostly done in CONTRIBUTING.rst but should provide link to the right place.
  2. How to extend the library with inheritance
  3. How to get the library instance from Robot Framework
  4. How to to extend the library without creating a new library to Robot Framework side.

Put the extending documentation in to the ./docs/extending/ folder.

@aaltat
Copy link
Contributor

aaltat commented Jan 9, 2018

The #1029 provides initial commit how the extending can be done.

@aaltat aaltat modified the milestones: v3.2.0, v3.1.0 Jan 16, 2018
@aaltat
Copy link
Contributor

aaltat commented Jan 16, 2018

This is done in #1029

@aaltat aaltat closed this as completed Jan 16, 2018
@aaltat aaltat added the alpha 1 label Feb 11, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants