Add tsdoc package documentation#4711
Merged
raymondfeng merged 3 commits intoloopbackio:masterfrom Apr 8, 2020
Merged
Conversation
achrinza
added
community-contribution
developer-experience
achrinza
force-pushed
the
docs/update-tsdocs
branch
3 times, most recently
from
56cf5f3 to
05a9d6c
Compare
raymondfeng
reviewed
Feb 22, 2020
achrinza
commented
Feb 22, 2020
achrinza
force-pushed
the
docs/update-tsdocs
branch
from
05a9d6c to
5d01691
Compare
achrinza
requested review from
agnes512,
bajtos,
deepakrkris,
emonddr,
hacksparrow,
jannyHou and
nabdelgadir
as code owners
Contributor
|
@achrinza Maybe it makes sense to squash all commits into one? |
derdeka
requested changes
Feb 24, 2020
Contributor
derdeka
left a comment
derdeka
left a comment
There was a problem hiding this comment.
Thanks for this PR, some high level comments.
- You are mixing
module,packageandcomponentforloopbackpackages which might be confusing. - Personally I like it more if the the tsdoc does not start with 'This module ...'.
- (How to create a doc preview on
windows?)
achrinza
force-pushed
the
docs/update-tsdocs
branch
from
8bc738b to
0ffdb52
Compare
Member
Author
|
@raymondfeng Good idea, I've squashed all the |
Member
Author
|
@derdeka For the most part, these were copy&pasted from the |
raymondfeng
reviewed
Feb 25, 2020
achrinza
force-pushed
the
docs/update-tsdocs
branch
from
0ffdb52 to
40b04aa
Compare
Member
achrinza
force-pushed
the
docs/update-tsdocs
branch
2 times, most recently
from
4cd3807 to
c1f8055
Compare
Member
Author
|
@dhmlau Thanks for re-raising the issue, it slipped from my radar 🙇; I've applied the feedback. WDYT? |
Member
|
@achrinza, thanks. Could you please also take care of the commit linting error? Thanks! @emonddr @raymondfeng @derdeka, may I get your review on this PR again please? |
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
update packageDocumentation to follow tsdoc best practices Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
Signed-off-by: Rifa Achrinza <25147899+achrinza@users.noreply.github.com>
achrinza
force-pushed
the
docs/update-tsdocs
branch
from
c1f8055 to
66a5169
Compare
37 tasks
raymondfeng
approved these changes
Apr 8, 2020
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Loosely related: #4697
This PR is part of a bigger incremental doc improvement.
As a starting point, the package documentation were, for the most part, copy-&-pasted from the respective
READMEfiles.Why this (and future tsdoc) PRs?
Why this PR?
This PR fixes the emptiness this page:
Self-TODO
Checklist
👉 Read and sign the CLA (Contributor License Agreement) 👈
npm testpasses on your machinepackages/cliwere updatedexamples/*were updated👉 Check out how to submit a PR 👈