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

Fix api docs loadconfigfile #3757

Merged
merged 4 commits into from Sep 3, 2020

Conversation

maxwell8888
Copy link
Contributor

@maxwell8888 maxwell8888 commented Sep 2, 2020

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

List any relevant issue numbers:

Description

The docs for rollup/dist/loadConfigFile incorrectly state that the options property of the object returned by loadConfigFile is an "inputOptions" object, when in fact it is an array of "inputOptions" objects. This PR fixes the text and code example in the docs.
Relevant stackoverflow question: https://stackoverflow.com/questions/62153013/rollup-js-use-rollup-config-js-in-js-api

@codecov
Copy link

codecov bot commented Sep 2, 2020

Codecov Report

Merging #3757 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #3757   +/-   ##
=======================================
  Coverage   97.02%   97.02%           
=======================================
  Files         185      185           
  Lines        6461     6461           
  Branches     1868     1868           
=======================================
  Hits         6269     6269           
  Misses        101      101           
  Partials       91       91           

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 266fd88...44c0bff. Read the comment docs.

Copy link
Member

@lukastaegert lukastaegert left a comment

Choose a reason for hiding this comment

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

Thanks for spotting and fixing this, always welcome!

@lukastaegert lukastaegert merged commit 581c1fc into rollup:master Sep 3, 2020
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.

None yet

2 participants