Skip to content
This repository has been archived by the owner on Apr 20, 2024. It is now read-only.

Data source doc update #14

Open
Casperhr opened this issue Dec 22, 2016 · 1 comment
Open

Data source doc update #14

Casperhr opened this issue Dec 22, 2016 · 1 comment
Assignees

Comments

@Casperhr
Copy link
Contributor

Lacking data source documentation
I am missing a section in the official docs regarding data sources. Persisting data is an integral part of most web based systems and there should be a dedicated section for this to make vapor more accessible to newcomers.
Also docs regarding column attributes in my data source. Nullable fields, unsigned integers etc.
Missing docblocks in the source
One of the best things about Laravel is that most of the code base is fully documented with doc blocks. They even have design guides to how doc blocks should look. Some parts of the code base is missing this (though I have also encountered several helpful ones)
Basic database operations
Database operations are not documented with clear examples. Common operations such as UPDATE and DELETE are not present in the docs. Only a very simple CREATE along with some generic JOIN example could be found.

@steffendsommer
Copy link
Contributor

Have you been working on this @rasmusebbesen or can I unassign you?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants