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

[APIDocs] Missing content from RepositoryMixin #1171

Closed
dhmlau opened this issue Mar 22, 2018 · 2 comments
Closed

[APIDocs] Missing content from RepositoryMixin #1171

dhmlau opened this issue Mar 22, 2018 · 2 comments
Assignees
Labels
Milestone

Comments

@dhmlau
Copy link
Member

dhmlau commented Mar 22, 2018

Description / Steps to reproduce / Feature proposal

For the RepositoryMixin apidocs section (http://apidocs.loopback.io/@loopback%2frepository/#1798), besides the tsdocs for the class, the rest are missing. For example tsdocs for repository and dataSource functions are missing.

Current Behavior

Only the description for RepositoryMixin class shows up, but nothing for the functions.

Expected Behavior

Should also show the tsdocs (including code examples) for the functions.

See Reporting Issues for more tips on writing good issues

@dhmlau dhmlau added the bug label Mar 22, 2018
@dhmlau
Copy link
Member Author

dhmlau commented Apr 19, 2018

The problem is the information is at the level inside the function body, what we can do is to put more information at the top level.

cc @raymondfeng @bajtos

@dhmlau dhmlau added the DP3 label Apr 19, 2018
@shimks
Copy link
Contributor

shimks commented Apr 19, 2018

The problem with the docs in repository.mixin.ts is that the order in which the docs introduce {summary, example, params} is wrong. Currently, the docs are written in this order: summary -> params -> example. It should be written in this order: summary -> example -> params. Just switching those should fix the problem (I think). Can someone with enough bandwidth try this?

EDIT: I've been able to verify that this does not fix the docs

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

No branches or pull requests

4 participants