Skip to content
This repository has been archived by the owner on Jul 29, 2024. It is now read-only.

The webdriver/protractor split in docs API is confusing #2169

Closed
juliemr opened this issue May 20, 2015 · 2 comments
Closed

The webdriver/protractor split in docs API is confusing #2169

juliemr opened this issue May 20, 2015 · 2 comments
Assignees

Comments

@juliemr
Copy link
Member

juliemr commented May 20, 2015

Users don't care that some functions are added by Protractor, and some are wrapped. It's confusing that locators, for example, live in two different locations. We should merge and present this more clearly.

@andresdominguez
Copy link
Contributor

We need examples for all the locators. The webdriver jsdocs do not have examples. Probably we need special annotations to extend examples.

We can have an empty file that contains a bunch of annotations for examples. What about something like this:

/**
 * @extendsDoc {webdriver.By.linkText}
 * @replaceDoc
 * [optional] Text that will replace the original jsdoc.
 * @appendDoc
 * [optional] Text that will be appended to the original webdriver jsdoc
 * @view
 * <a>Julie</a>
 * <a>Hank</a>
 *
 * @example
 * expect(element(by.linkText('Julie')).isPresent()).toBe(true);
 */

@juliemr
Copy link
Member Author

juliemr commented Jun 30, 2015

Assigning @sjelin as he's working on it.

sjelin added a commit to sjelin/protractor that referenced this issue Jun 30, 2015
sjelin added a commit to sjelin/protractor that referenced this issue Jun 30, 2015
@sjelin sjelin closed this as completed in 7e8d4fd Jun 30, 2015
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants