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

Confusing docs about command line flags #2639

Closed
1 of 4 tasks
everdimension opened this issue Jan 4, 2019 · 2 comments · Fixed by #2641
Closed
1 of 4 tasks

Confusing docs about command line flags #2639

everdimension opened this issue Jan 4, 2019 · 2 comments · Fixed by #2641

Comments

@everdimension
Copy link
Contributor

Documentation Is:

  • Missing
  • Needed
  • Confusing
  • Not Sure?

Please Explain in Detail...

The section about command line flags

I see a list of options which I expect to be exhaustive. I'm looking for a --watch option. It's not there. Hmm, does rollup not provide a watch option out of the box? 🤔

But then... After the list, there's a paragraph that says:

In addition, the following arguments can be used:

God this is so confusing. "In addition"? Why didn't these options deserve to be in the main list?

Your Proposal for Changes

If these options are indeed somehow fundamentally different, I'd love to see the docs making it clear. Right now it just looks like a joke on the reader.
If not, they should be in the main list and the list should be exhaustive.

@lukastaegert
Copy link
Member

Thanks for the feedback, please have a look at #2641 for my attempt on improving this.

@everdimension
Copy link
Contributor Author

The PR looks great! Much more clear.

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

Successfully merging a pull request may close this issue.

2 participants