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

Missing documentation in Annotated Entities section #35

Closed
paquettg opened this issue Oct 22, 2019 · 3 comments
Closed

Missing documentation in Annotated Entities section #35

paquettg opened this issue Oct 22, 2019 · 3 comments

Comments

@paquettg
Copy link

paquettg commented Oct 22, 2019

Hey,

In the Annotated Entities section (https://github.com/cycle/docs/blob/master/annotated/entity.md) you have the following statement about primary keys.

" (you still can create a compound primary key, see below)."

but their is no further mention of how to create compound primary keys.

Can you please add this documentation or link to the page that has this information?

@wolfy-j
Copy link
Contributor

wolfy-j commented Oct 22, 2019

This is an incorrect statement, for now,, sorry about that. The compound PK work can be tracked here: cycle/orm#22

You can add you like to that issue if you want to push it up in priority, we are trying to focus on what is important.

@paquettg
Copy link
Author

Hey @wolfy-j ,

Thanks for the quick update, I have marked that issue as liked.

I also noticed this other part of the documentation that would be helpful

'Read how to use non-incremental primary keys (for example UUID) in the Advanced section.'

but I can't find the advanced section regarding to this implementation. Is this a part of issue 22 also or can we add a link to the advanced section that this is refering to?

Thanks.

@wolfy-j
Copy link
Contributor

wolfy-j commented Oct 22, 2019

That's just the legacy documentation format. I'll appreciate if you can submit the PR to fix it. The UUID is in Customizations now https://github.com/cycle/docs/blob/master/advanced/uuid.md

@wolfy-j wolfy-j closed this as completed Oct 27, 2019
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