remarkjs / remark-github

remark plugin to link references to commits, issues, pull-requests, and users, like on GitHub

https://remark.js.org

MIT License

179 stars 22 forks source link

Fix description of main export #34

Closed vweevers closed 3 years ago

vweevers commented 3 years ago

Initial checklist

[x] I read the support docs
[x] I read the contributing guide
[x] I agree to follow the code of conduct
[x] I searched issues and couldn’t find anything (or linked relevant results below)
[x] ~~If applicable, I’ve added docs and tests~~

Description of changes

The description in the jsdoc/tsdoc comment of the main export seems to have been copied from another plugin; this corrects it.

github-actions[bot] commented 3 years ago

Hi! It seems some of the things asked in the template are missing? Please edit your post to fill out everything.

[ ] Initial checklist (todo)
[x] Description of changes

You won’t get any more notifications from me, but I’ll keep on updating this comment, and remove it when done!

If you need it, here’s the original template

```markdown ### Initial checklist * [ ] I read the support docs * [ ] I read the contributing guide * [ ] I agree to follow the code of conduct * [ ] I searched issues and couldn’t find anything (or linked relevant results below) * [ ] If applicable, I’ve added docs and tests ### Description of changes TODO ```

Thanks, — bb

wooorm commented 3 years ago

nice catch, thanks!

codecov-commenter commented 3 years ago

Codecov Report

Merging #34 (2dfeaa4) into main (39e5822) will not change coverage. The diff coverage is 100.00%.

@@            Coverage Diff            @@
##              main       #34   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            3         3           
  Lines          518       518           
=========================================
  Hits           518       518

Impacted Files	Coverage Δ
lib/index.js	`100.00% <100.00%> (ø)`

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 39e5822...2dfeaa4. Read the comment docs.

github-actions[bot] commented 3 years ago

Hi! This was closed. Team: If this was merged, please describe when this is likely to be released. Otherwise, please add one of the no/* labels.

wooorm commented 3 years ago

Thanks Vincent, released!

paescuj commented 2 years ago

FYI: It seems like the version 11.2.2 has been published without rebuilding - at least the description is still wrong...

wooorm commented 2 years ago

Weird! I cut another release and verified it’s there https://github.com/remarkjs/remark-github/releases/tag/11.2.3

paescuj commented 2 years ago

Nice, thanks for the fast reaction!