Skip to content
This repository has been archived by the owner on Dec 15, 2022. It is now read-only.

Improve JSDoc grammar #439

Merged
merged 3 commits into from Oct 8, 2016
Merged

Conversation

MoritzKn
Copy link
Contributor

@MoritzKn MoritzKn commented Oct 7, 2016

  • Add @param synonyms @arg and @argument
  • Remove the hyphen before the description from the capture

See: http://usejsdoc.org/tags-param.html

@MoritzKn MoritzKn changed the title Improve js doc grammar Improve JSDoc grammar Oct 7, 2016
@50Wliu
Copy link
Contributor

50Wliu commented Oct 7, 2016

Awesome, thanks! Can you please add some specs for this?

- hyphen before the description
- @arg and @argument synonyms for @param tag
@MoritzKn
Copy link
Contributor Author

MoritzKn commented Oct 8, 2016

@50Wliu done. 😃

@50Wliu 50Wliu merged commit 2eefe85 into atom:master Oct 8, 2016
@50Wliu
Copy link
Contributor

50Wliu commented Oct 8, 2016

Thanks!

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

Successfully merging this pull request may close these issues.

None yet

2 participants