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

Conversation

Projects
None yet
1 participant
@ricardograca
Copy link
Member

commented Feb 19, 2019

  • Related Issues: #800

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.

ricardograca added some commits Dec 27, 2018

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

- Also fixes a few mistakes in some doclets.
Simplify Model.extend doclet example
- The more complicated and unrelated aspects of the previous example 
will be moved to the Model guide.

@ricardograca ricardograca added the docs label Feb 19, 2019

@ricardograca ricardograca merged commit 39e8211 into master Feb 20, 2019

2 checks passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@ricardograca ricardograca deleted the rg-jsdoc branch Feb 20, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.