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

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

Merged
merged 1 commit into from Nov 27, 2018

Conversation

@javiertury
Copy link
Contributor

@javiertury javiertury commented Nov 16, 2018

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 codecov bot commented Nov 16, 2018

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 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 javiertury:dynamic-oids-doc branch 2 times, most recently from 5354b42 to f093930 Nov 24, 2018
@javiertury
Copy link
Contributor Author

@javiertury javiertury commented Nov 24, 2018

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.

@@ -0,0 +1,332 @@
## Basic data types

This comment has been minimized.

@sushantdhiman

sushantdhiman Nov 26, 2018
Contributor

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

This comment has been minimized.

@javiertury

javiertury Nov 26, 2018
Author Contributor

Done.

@javiertury javiertury force-pushed the javiertury:dynamic-oids-doc branch from f093930 to 938c874 Nov 26, 2018
@sushantdhiman sushantdhiman merged commit 89b8d47 into sequelize:master Nov 27, 2018
1 of 2 checks passed
1 of 2 checks passed
continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/appveyor/pr AppVeyor build succeeded
Details
@sushantdhiman
Copy link
Contributor

@sushantdhiman sushantdhiman commented Nov 27, 2018

Thanks @javiertury

@janmeier
Copy link
Member

@janmeier janmeier commented Nov 28, 2018

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

SimonSchick added a commit to SimonSchick/sequelize that referenced this pull request Dec 8, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Linked issues

Successfully merging this pull request may close these issues.

None yet

3 participants