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

docs: add specific relation decorators #2214

Merged
merged 1 commit into from
Jan 11, 2019
Merged

Conversation

nabdelgadir
Copy link
Contributor

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

bajtos
bajtos previously requested changes Jan 7, 2019
Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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._

docs/site/Decorators_repository.md Outdated Show resolved Hide resolved
docs/site/Decorators_repository.md Outdated Show resolved Hide resolved
@bajtos bajtos added feature Docs Relations Model relations (has many, etc.) labels Jan 7, 2019
@nabdelgadir nabdelgadir force-pushed the relation-decorator-doc branch 2 times, most recently from 729ef04 to a9d883f Compare January 9, 2019 18:21
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 Show resolved Hide resolved
@bajtos bajtos dismissed their stale review January 10, 2019 12:22

the original comments have been addressed

@nabdelgadir
Copy link
Contributor Author

@bajtos @b-admike LGTY?

Copy link
Contributor

@b-admike b-admike left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work 👍 LGTM.

Copy link
Member

@bajtos bajtos left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏

@nabdelgadir nabdelgadir merged commit 63d4288 into master Jan 11, 2019
@nabdelgadir nabdelgadir deleted the relation-decorator-doc branch January 11, 2019 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Docs feature Relations Model relations (has many, etc.)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants