Replicate the Ecto.Repo documentation

[joeljuca]

Most functions that SwissSchema defines in Ecto schemas are very similar to the equivalent function in Ecto.Repo. So, I believe the documentation must be as close as possible.

We should also add some clear notices stating functions that have different shapes or return types, etc. (see #1).

SwissSchema functions

• [x] aggregate(type, opts)
• [x] aggregate(type, field, opts)
• [x] all(opts)
• [x] create(params, opts)
• [x] create!(params, opts)
• [x] delete(schema, opts)
• [x] delete!(schema, opts)
• [x] delete_all(opts)
• [x] get(id, opts)
• [x] get!(id, opts)
• [x] get_by(clauses, opts)
• [x] get_by!(clauses, opts)
• [x] insert(params, opts)
• [x] insert!(params, opts)
• [x] insert_all(entries, opts)
• [ ] insert_or_update(changeset, opts)
• [ ] insert_or_update!(changeset, opts)
• [ ] stream(opts)
• [ ] update(schema, params, opts)
• [ ] update!(schema, params, opts)
• [ ] update_all(updates, opts)

[joeljuca]

After struggling to replicate Ecto.Repo docs in SwissSchema, I don't believe it's reasonable to keep them paired anymore. The reason? Well, Ecto docs are really big, and the effort to keep them in sync will be much bigger than what I'm able to do. It's not gonna happen.

What I'll be doing is to keep docs very simple, and point to Ecto's respective callbacks and/or functions. Good enough to start with, and definitely better than no docs at all.