Documentation for webdriverio incorrectly says element when it means element id.

[PHUITesting]

// webdriver.io example
driver.touchScroll({
el: element,
xOffset: 10,
yOffset: 100
});

Error:
Wrong parameters applied for touchScroll
Usage: touchScroll(xoffset, yoffset, element)

Property Description:
"xoffset" (number): the x offset in pixels to scroll by
"yoffset" (number): the y offset in pixels to scroll by
"element" (string): ID of the element where the scroll starts

For more info see https://github.com/SeleniumHQ/selenium/wiki/JsonWireProtocol#sessionsessionidtouchscroll

Documentation doesn't specify this is just an ID, it just says element.

[christian-bromann]

Documentation doesn't specify this is just an ID, it just says element.

Can you propose a fix? I am not quite sure what you are talking about.

[PHUITesting]

The proposed fix would be updating the docs here - http://v4.webdriver.io/v3.4/api/protocol/touchScroll.html

To include in the description that it has to be an id property of an element, not just an 'element'. I think the error message is more descriptive than the docs.

Can I pull request the docs somehow?

[christian-bromann]

Can I pull request the docs somehow?

Yes, just press on the Edit button.

[christian-bromann]

@PHUITesting any luck?

[christian-bromann]

Closing due to inactivity.