Conflicting / missing information on enums
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 35/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- postgresql
- Domain
- databases, documentation
Research direction
Start with the v6 “Other Data Types” page and the Enum API reference linked in the issue, then verify the documented dialect support for enums. Update the relevant documentation so both references state the same support information, and confirm that the section heading or API note is consistent with the v6 behavior.
Written by the indexing model from the issue text.
Description
Issue Creation Checklist
[x] I have read the contribution guidelines
Issue Description
What was unclear/insufficient/not covered in the documentation
The docs, under "Other Data Types", don't mention that enums are Postgres only, but the API reference does. Since "Other Data Types" calls out a number of features that are dialect-specific, the omission of this info leads one to assume that enums are supported across all dialects (somehow)
If possible: Provide some suggestion on how we can enhance the docs
If enums are indeed only supported on Postgres, this information should be added to the Other Data Types page by changing the section header (consistent with e.g. "Ranges (PostgreSQL Only").
If enums work on all dialects, the incorrect note "An enumeration, Postgres Only
"should be deleted from the API reference
Additional context
edit: This concerns v6. v7 has an appropriate notice.
- Dominant language
- HTML
- Stars
- 30
- Forks
- 171
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from sequelize/website
-
docs: Managed Postgres callout + optional Appwrite link on postgres.mdx?Possibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 1-3 hours Newbie friendliness 74/100
-
Update Migration.mdOpen
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Error: Only HasMany associations support include.separateMay be free again @SippieCup claimed this 189 days ago, and no pull request is open. Open
-
Difficulty 2/5 1-3 hours Newbie friendliness 55/100
All issues in sequelize/website
Similar issues
-
Edit: Cinemax LatinoOpenchannels:edit check:passed
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Maintainers usually reply within 4 days
-
data-model security
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
Popoboxxo/ReqogniLoom#1184 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
coollabsio/coolify#12094 · 1 comment ·
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
apache/iceberg-rust#3348 ·
Maintainers usually reply within 1 day