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

chore(docs): Cleanup plugin docs #4079

Merged
merged 1 commit into from
Feb 8, 2017
Merged

Conversation

sjelin
Copy link
Contributor

@sjelin sjelin commented Feb 7, 2017

  • Removed redundent information in /docs/plugins.md. Now redirects to
    /lib/plugins.ts.
  • Comment cleanup in /lib/plugins.ts
  • Export some necessary types in /lib/index.ts

docs/plugins.md Outdated
```

Each of these exported properties are optional.
Plugins are node modules who's `module.exports` implement the `ProtractorPlugin`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe "Plugins are a node module that export an object implementing the ProtractorPlugin interface"?

lib/plugins.ts Outdated
@@ -188,40 +191,44 @@ export interface ProtractorPlugin {
* before executing the next command. This can be disabled using
* browser.ignoreSynchronization, but that will also disable any
* <Plugin>.waitForPromise or <Plugin>.waitForCondition checks. If you want
* to
* disable synchronization with angular, but leave in tact any custom plugin
* to disable synchronization with angular, but leave in tact any custom plugin
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"intact"

* Removed redundent information in `/docs/plugins.md`.  Now redirects to
  `/lib/plugins.ts`.
* Comment cleanup in `/lib/plugins.ts`
* Export some necessary types in `/lib/index.ts`
@sjelin sjelin merged commit c1df958 into angular:master Feb 8, 2017
igniteram pushed a commit to igniteram/protractor that referenced this pull request Feb 21, 2017
* Removed redundent information in `/docs/plugins.md`.  Now redirects to
  `/lib/plugins.ts`.
* Comment cleanup in `/lib/plugins.ts`
* Export some necessary types in `/lib/index.ts`
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants