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

Inaccurate/confusing description for column :primary_key #1670

Closed
dteoh opened this issue Jan 11, 2020 · 1 comment
Closed

Inaccurate/confusing description for column :primary_key #1670

dteoh opened this issue Jan 11, 2020 · 1 comment

Comments

@dteoh
Copy link

dteoh commented Jan 11, 2020

In the docs for Sequel::Schema::CreateTableGenerator#column :primary_key option:

"This should not be used if you have a single, nonautoincrementing primary key column (use the primary_key method in that case)."

This is the opposite, you should not use it if you have an autoincrement PK column.

I think maybe rewriting this to when you can use the option would be easier to read?

"This should be used if you do not want to use an auto-incrementing PK column."

@jeremyevans
Copy link
Owner

Thanks for catching that. I'll fix the documentation shortly.

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

No branches or pull requests

2 participants