Skip to content
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

README (Documentation) #133

Closed
skipjack opened this issue Feb 7, 2018 · 2 comments
Closed

README (Documentation) #133

skipjack opened this issue Feb 7, 2018 · 2 comments

Comments

@skipjack
Copy link

skipjack commented Feb 7, 2018

In regards to webpack/webpack.js.org#1754 and this comment.

The documentation on the next branch of webpack.js.org now points to this package and it's README more prominently from the resolvers.md page. It seems the README for this package is totally out of date with the current code (though I could be wrong). I think the following needs to be documented:

  • Each available hook (preferably using the same format we use here)
    • Type of underlying tapable hook
    • Brief description and optionally a small example
    • Any parameters passed
  • A description of each available class method and their parameters (e.g. doResolve)

@mlcohen, seeing as you dug into this a bit in webpack/webpack.js.org#1458, would you be willing to help out with updating this README? You may want to collaborate with @sokra and @TheLarkInn as I think the API changed a bit recently.

@skipjack
Copy link
Author

skipjack commented Feb 7, 2018

This might be related to #119, though I'm not 100% on that.

@alexander-akait
Copy link
Member

Let's close in favor #119 (comment)

@bugknightyyp bugknightyyp mentioned this issue Jul 26, 2020
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants