Skip to content

docs(config,plugins) type updates #3294

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

Merged
merged 3 commits into from
Sep 30, 2019
Merged

docs(config,plugins) type updates #3294

merged 3 commits into from
Sep 30, 2019

Conversation

EugeneHlushko
Copy link
Member

Convert types to the ones defined in contribute section, also spotted missing examples and types in configuration section

@netlify
Copy link

netlify bot commented Sep 20, 2019

Preview is ready

Built with commit 2ecad29

https://deploy-preview-3294--webpackjsorg-netlify.netlify.com

Copy link
Member

@rishabh3112 rishabh3112 left a comment

Choose a reason for hiding this comment

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

Would be great to have | for union types in docs.

@@ -14,4 +15,4 @@ new webpack.WatchIgnorePlugin(paths);

## Options

- `paths` (array): A list of RegExps or absolute paths to directories or files that should be ignored
- `paths` (`[string, RegExp]`): A list of RegExps or absolute paths to directories or files that should be ignored
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- `paths` (`[string, RegExp]`): A list of RegExps or absolute paths to directories or files that should be ignored
- `paths` (`[string | RegExp]`): A list of RegExps or absolute paths to directories or files that should be ignored

Copy link
Member Author

Choose a reason for hiding this comment

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

Copy link
Member Author

Choose a reason for hiding this comment

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

We can have a discussion on how to improve it outisde of this pr

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

Successfully merging this pull request may close these issues.

2 participants