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

Update and fix a lot of doclets #1951

Merged
merged 26 commits into from
Feb 20, 2019
Merged

Update and fix a lot of doclets #1951

merged 26 commits into from
Feb 20, 2019

Conversation

ricardograca
Copy link
Member

Introduction

This fixes or adds missing information to a lot of JSDoc doclets.

Motivation

Some doclets were outdated and needed some extra info or clarification since some details weren't very obvious. Check the linked issue for more details.

Closes #800.

Current PR Issues

This isn't an extensive rewrite of all the doclets, so a lot of issues still remain. We should consolidate their styles at some point since they are all very different and sometimes hard to know how to format.

- The previous example was giving too much emphasis to the 
Collection#through() method instead. This clarifies that distinction.
- Uses the @Lends keyword to avoid having to explicitly add the name 
parameter to each doclet.

- Also fixes a few mistakes in some doclets.
- The more complicated and unrelated aspects of the previous example 
will be moved to the Model guide.
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.

Checklist for moving to JSDoc
1 participant