Skip to content

Conversation

@ankon
Copy link
Contributor

@ankon ankon commented May 26, 2018

The code handles them as optional with a default of '{}', and the README similarly shows the examples without any options argument.

@dougwilson dougwilson self-assigned this May 26, 2018
@dougwilson dougwilson added the pr label May 26, 2018
@ankon
Copy link
Contributor Author

ankon commented May 26, 2018

I've added some 'options' as a description of the option. Reads a bit funny, but avoids more warnings with linters that want no empty doc comments :)

@dougwilson
Copy link
Contributor

Would that be linters that run on user's of router projects, or run against the router source code itself?

@ankon
Copy link
Contributor Author

ankon commented May 26, 2018

Typically you'd be running linters on your own code only, not the dependencies. ... Except for the linter in my head, which got quite conditioned already to fix empty JSDocs parts. I'm not sure about this project our your environment, but I can see defaults of users that open this one in their IDE make this appear as a warning.

In any case, I just wanted to explain why I added the word 'options' :)

@dougwilson
Copy link
Contributor

Gotcha. Yea, I was just checking if it's something external users would run into and so something we'd want to add a check to prevent in the future. It doesn't sound like this is the case here, though.

dougwilson pushed a commit to ankon/router that referenced this pull request Jul 2, 2018
@dougwilson dougwilson merged commit badc3da into pillarjs:master Jul 2, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants