Skip to content

feat(documentation): explain custom/new postgres data types #10170

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.

Sign up for GitHub

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

Jump to bottom
Merged
sushantdhiman merged 1 commit into from
Nov 27, 2018
Merged

feat(documentation): explain custom/new postgres data types #10170

sushantdhiman merged 1 commit into from
Nov 27, 2018

Conversation

@javiertury
Copy link
Contributor

@javiertury javiertury commented Nov 16, 2018 •
edited
Loading

Pull Request check-list

  • Does npm run test or npm run test-DIALECT pass with this change (including linting)?
  • Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
  • Have you added new tests to prevent regressions?
  • Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
  • Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description of change

Issue #10114. I propose to document how to add custom data types. In this pull request I illustrate only how to add postgres data types.

@codecov
Copy link

codecov bot commented Nov 16, 2018 •
edited
Loading

Codecov Report

Merging #10170 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #10170   +/-   ##
=======================================
  Coverage   96.34%   96.34%           
=======================================
  Files          63       63           
  Lines        9420     9420           
=======================================
  Hits         9076     9076           
  Misses        344      344

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update f2cafcc...938c874. Read the comment docs.

@sushantdhiman
Copy link
Contributor

sushantdhiman commented Nov 17, 2018

I suggest create a new page called Datatypes, move stuff from https://github.com/sequelize/sequelize/blob/master/docs/models-definition.md#data-types and then add a section about customization

@javiertury javiertury force-pushed the dynamic-oids-doc branch 2 times, most recently from 5354b42 to f093930 Compare November 24, 2018 15:13
@javiertury
Copy link
Contributor Author

javiertury commented Nov 24, 2018 •
edited
Loading

That part is done. I did not find tests for documentation, if such a thing exists. I have just used grep to find a repair broken links.

sushantdhiman
sushantdhiman reviewed Nov 26, 2018
View reviewed changes
docs/data-types.md Outdated
@@ -0,0 +1,332 @@
## Basic data types
Copy link
Contributor

@sushantdhiman sushantdhiman Nov 26, 2018

Choose a reason for hiding this comment

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

Begin with # Datatypes, so nav item is also named as Datatypes

Copy link
Contributor Author

@javiertury javiertury Nov 26, 2018

Choose a reason for hiding this comment

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

Done.

@sushantdhiman sushantdhiman merged commit 89b8d47 into sequelize:master Nov 27, 2018
@sushantdhiman
Copy link
Contributor

sushantdhiman commented Nov 27, 2018

Thanks @javiertury

@janmeier
Copy link
Member

janmeier commented Nov 28, 2018

👍 I've been meaning to write something like this for ages! :)

SimonSchick pushed a commit to SimonSchick/sequelize that referenced this pull request Dec 8, 2018
@javiertury @SimonSchick
docs: explain custom/new data types (sequelize#10170)
6d248e6
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

1 more reviewer

@sushantdhiman sushantdhiman sushantdhiman approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@javiertury @sushantdhiman @janmeier