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

Remove @desc tag in ESDoc comments for method definitions #19

Open
arnellebalane opened this issue Jan 25, 2019 · 0 comments
Open

Remove @desc tag in ESDoc comments for method definitions #19

arnellebalane opened this issue Jan 25, 2019 · 0 comments
Labels
good first issue Good for newcomers

Comments

@arnellebalane
Copy link
Member

arnellebalane commented Jan 25, 2019

The first paragraph in the comment is already treated as the description for the method (please verify this though by checking the generated docs).

Currently affected methods are:

  • all
  • any
  • append
  • assoc
  • at

Also update the descriptions remove <br> tags and instead use multiple paragraphs directly, e.g.

Before:

/**
 *  Lorem ipsum dolor...<br>This is another paragraph...
 */

After:

/**
 *  Lorem ipsum dolor...
 *
 *  This is another paragraph...
 */
@arnellebalane arnellebalane added the good first issue Good for newcomers label Jan 25, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant