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

docs: add specific relation decorators #2214

Merged
merged 1 commit into from Jan 11, 2019

Conversation

Projects
None yet
3 participants
@nabdelgadir
Copy link
Contributor

nabdelgadir commented Jan 4, 2019

Connect to #1910.

Add syntax and examples to belongsTo, hasOne, and hasMany decorator docs.

Checklist

  • npm test passes on your machine
  • New tests added or existing tests modified to cover all changes
  • Code conforms with the style guide
  • API Documentation in code was updated
  • Documentation in /docs/site was updated
  • Affected artifact templates in packages/cli were updated
  • Affected example projects in examples/* were updated

@nabdelgadir nabdelgadir requested review from bajtos and raymondfeng as code owners Jan 4, 2019

@nabdelgadir nabdelgadir self-assigned this Jan 4, 2019

@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch from 8ea1630 to 8ea5b32 Jan 4, 2019

@bajtos
Copy link
Member

bajtos left a comment

Great addition to our docs.

While changing this area, I think we should also modify or remove the following note on lines 122/123 and 133/134. Perhaps explain what has been finished & released for general use, what is not implemented yet, and add links to GitHub issues where readers can find more information about the progress.

_This feature has not yet been released in alpha form. Documentation will be
added here as this feature progresses._
Show resolved Hide resolved docs/site/Decorators_repository.md Outdated
Show resolved Hide resolved docs/site/Decorators_repository.md Outdated

@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch 2 times, most recently from 729ef04 to a9d883f Jan 8, 2019

Show resolved Hide resolved docs/site/Decorators_repository.md Outdated
Show resolved Hide resolved docs/site/Decorators_repository.md Outdated
Show resolved Hide resolved docs/site/Decorators_repository.md Outdated

@bajtos bajtos dismissed their stale review Jan 10, 2019

the original comments have been addressed

@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch from a9d883f to 8d7bc26 Jan 10, 2019

@nabdelgadir

This comment has been minimized.

Copy link
Contributor Author

nabdelgadir commented Jan 10, 2019

@b-admike
Copy link
Member

b-admike left a comment

Nice work 👍 LGTM.

@bajtos

bajtos approved these changes Jan 11, 2019

Copy link
Member

bajtos left a comment

👏

@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch from 8d7bc26 to 43c98e8 Jan 11, 2019

@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch from 43c98e8 to 4464c57 Jan 11, 2019

@nabdelgadir nabdelgadir merged commit 63d4288 into master Jan 11, 2019

5 checks passed

clahub All contributors have signed the Contributor License Agreement.
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
continuous-integration/travis-ci/pr The Travis CI build passed
Details
coverage/coveralls Coverage remained the same at 90.281%
Details
security/snyk - package.json (dhmlau) No new issues
Details

@nabdelgadir nabdelgadir deleted the relation-decorator-doc branch Jan 11, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment