Skip to content

Conversation

@rschristian
Copy link
Contributor

This PR contains:

  • bugfix
  • feature
  • refactor
  • documentation
  • other

Are tests included?

  • yes (bugfixes and features will not be merged without tests)
  • no

Breaking Changes?

  • yes (breaking changes will not be merged unless absolutely necessary)
  • no

Description

It seems this option text was misplaced.

Reading through the docs, I was a bit baffled as to how assetHookStage was intended to be used seeing as how it was listed next to getCompilerHooks, which is an export. The "Usage" section that immediately follows is also entirely unrelated to this functionality, which was confusing.

This also corrects the formatting to ensure the type and default values are on different lines, matching the rest of the options.

@rschristian rschristian changed the title docs: Correct location of assetHookStage docs docs: Correct location of assetHookStage in readme Mar 22, 2022
@shellscape
Copy link
Owner

Thanks for catching this. Please put the option in alphabetical order in that section and we'll be able to merge.

@rschristian
Copy link
Contributor Author

Whoops, don't know how I missed the alphabetical order. Sorry about that.

Should be corrected now.

@shellscape
Copy link
Owner

thanks!

@shellscape shellscape merged commit 6a52160 into shellscape:master Mar 24, 2022
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

Successfully merging this pull request may close these issues.

2 participants