Skip to content

Document how to extend the library #1007

Closed

Description

@pekkaklarck

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.

Activity

  1. pekkaklarck commented on Dec 1, 2017

    @pekkaklarck
    MemberAuthor

    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/

  2. added this to the v3.1.0 milestone on Dec 3, 2017
  3. aaltat commented on Dec 3, 2017

    @aaltat
    Contributor

    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.

  4. aaltat commented on Jan 9, 2018

    @aaltat
    Contributor

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

  5. modified the milestones: v3.2.0, v3.1.0 on Jan 16, 2018
  6. aaltat commented on Jan 16, 2018

    @aaltat
    Contributor

    This is done in #1029

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions