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

New: allows plugins to specify the URLs to their docs (fixes #6582) #6589

Closed
wants to merge 1 commit into from

Conversation

pmcelhaney
Copy link
Contributor

This is a first pass at implementation. I'm putting it out now to get feedback. Will come back and write a proper commit message.

@eslintbot
Copy link

Thanks for the pull request, @pmcelhaney! I took a look to make sure it's ready for merging and found some changes are needed:

  • The commit summary needs to begin with a tag (such as Fix: or Update:). Please check out our guide for how to properly format your commit summary and update it on this pull request.
  • Pull requests with code require an issue to be mentioned at the end of the commit summary, such as (fixes #1234). Please update the commit summary with an issue (file a new issue if one doesn't already exist).

Can you please update the pull request to address these?

(More information can be found in our pull request guide.)

@jquerybot
Copy link

Thank you for your pull request. It looks like this may be your first contribution to a jQuery Foundation project, if so we need you to sign our Contributor License Agreement (CLA).

📝 Please visit http://contribute.jquery.org/CLA/ to sign.

After you signed, the PR is checked again automatically after a minute. If there's still an issue, please reply here to let us know.


If you've already signed our CLA, it's possible your git author information doesn't match your CLA signature (both your name and email have to match), for more information, check the status of your CLA check.

};
```


Copy link
Contributor Author

Choose a reason for hiding this comment

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

Lots of useless whitespace. I'll clean this up.

module.exports = {
getDocURI: function(ruleName) {
return "http://path.to/docs/" + ruleName;
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thinking it may be useful to pass the problem object as a second argument so the plugin can link to more specific detail about how the rule was violated. An IDE could even fetch the URL and provide contextual help.

But that's another PR for another day.

@eslintbot
Copy link

LGTM

@pmcelhaney pmcelhaney changed the title WIP: Allow plugins to specify the URLs to their docs #6582 New: allows plugins to specify the URLs to their docs (fixes #6582) Jul 4, 2016
@eslintbot
Copy link

LGTM

@vitorbal vitorbal added the do not merge This pull request should not be merged yet label Jul 4, 2016
@vitorbal
Copy link
Member

vitorbal commented Jul 4, 2016

thanks for the PR, @pmcelhaney! Adding the "do not merge" label for now while we discuss the details in #6582

@pmcelhaney
Copy link
Contributor Author

Closing based on feedback from the team.

@pmcelhaney pmcelhaney closed this Jul 5, 2016
@eslint-deprecated eslint-deprecated bot locked and limited conversation to collaborators Feb 6, 2018
@eslint-deprecated eslint-deprecated bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Feb 6, 2018
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
archived due to age This issue has been archived; please open a new issue for any further discussion do not merge This pull request should not be merged yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants