Navigation Menu

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

sequelize instance does not have a Model field (import docs) #11424

Closed
2 of 7 tasks
masterl opened this issue Sep 12, 2019 · 1 comment · Fixed by #11825
Closed
2 of 7 tasks

sequelize instance does not have a Model field (import docs) #11424

masterl opened this issue Sep 12, 2019 · 1 comment · Fixed by #11825
Assignees
Labels
type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.

Comments

@masterl
Copy link

masterl commented Sep 12, 2019

Issue Description

The import docs present a wrong code:

module.exports = (sequelize, DataTypes) => {
  class Project extends sequelize.Model { }

What was unclear/insufficient/not covered in the documentation

The problem here is that there is no field called Model on the sequelize instance.

If possible: Provide some suggestion on how we can enhance the docs

Throughout the docs, sequelize is used for the Sequelize instance.
And Sequelize is used for what we get when we require('sequelize').
Since Model is a part of Sequelize (with capital S), this part of the doc should be rewritten to Sequelize.Model.

Additional context

Add any other context or screenshots about the issue here.

Issue Template Checklist

Is this issue dialect-specific?

  • No. This issue is relevant to Sequelize as a whole.
  • Yes. This issue only applies to the following dialect(s): XXX, YYY, ZZZ
  • I don't know.

Would you be willing to resolve this issue by submitting a Pull Request?

  • Yes, I have the time and I know how to start.
  • Yes, I have the time but I don't know how to start, I would need guidance.
  • No, I don't have the time, although I believe I could do it if I had the time...
  • No, I don't have the time and I wouldn't even know how to start.
@masterl masterl added the type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference. label Sep 12, 2019
@papb
Copy link
Member

papb commented Sep 14, 2019

Thanks! I will fix this while I'm making the other docs changes.

@papb papb self-assigned this Sep 14, 2019
@papb papb added the status: wip For issues and PRs. Applied when the PR is not ready yet / when work to close the issue has started. label Sep 14, 2019
@papb papb removed the status: wip For issues and PRs. Applied when the PR is not ready yet / when work to close the issue has started. label Jan 15, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: docs For issues and PRs. Things related to documentation, such as changes in the manuals / API reference.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants