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

Improved documentation #198

Merged
merged 18 commits into from
Mar 5, 2020
Merged

Improved documentation #198

merged 18 commits into from
Mar 5, 2020

Conversation

nicolas-van
Copy link
Contributor

@nicolas-van nicolas-van commented Mar 5, 2020

Hello,

This is a big change in the organization of the documentation. The story is that I lost quite a lot of time trying to understand how this project works and had to read directly the code in the end because I wasn't able to understand the current doc.

I kept most of it, re-organized it in a more logical way, provided a full working example and modernized a little the examples that already existed.

// Defaults to `Sequelize.STRING`
columnType: new Sequelize.STRING(100)
}
;(async () => {
Copy link
Contributor

Choose a reason for hiding this comment

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

unnecessary semi

Copy link
Contributor Author

@nicolas-van nicolas-van Mar 5, 2020

Choose a reason for hiding this comment

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

Actually no, it is strictly mandatory. You can even test it to see it won't compile.

That's just a common pattern found in no-semicolon javascript coding style to force a proper understanding by the compiler in those very specific cases where we want to start a line with a column.

Copy link
Contributor

Choose a reason for hiding this comment

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

Right, codebase is not using semi

Copy link
Contributor

@sushantdhiman sushantdhiman left a comment

Choose a reason for hiding this comment

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

LGTM, thanks @nicolas-van

@sushantdhiman sushantdhiman merged commit ae37f74 into sequelize:master Mar 5, 2020
@papb
Copy link
Member

papb commented Mar 5, 2020

This fantastic, thank you very much! Excellent!!

@nicolas-van
Copy link
Contributor Author

Thanks :)

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

Successfully merging this pull request may close these issues.

3 participants