/diesel

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

Review some of our really old docs #1180

Closed
sgrif opened this Issue Sep 20, 2017 · 3 comments

Comments

Assignees

@notryanb notryanb

Labels
Projects
None yet
Milestone
No milestone
4 participants
@sgrif @notryanb @weiznich @killercup
@sgrif
Member

sgrif commented Sep 20, 2017

I noticed this gem in the docs for insert:

This function is not exported by default.

I don't even know what I meant by that. I think I meant that use diesel::*; wouldn't import insert? That isn't true anymore, and even if it was that's not a super relevant thing to document.

It also states:

As with other commands, the resulting query can return the inserted rows if you choose.

which is only true on PG (the only backend we support that has a RETURNING clause. We should probably do a pass over all the functions that have been around since 0.1 (everything in query_builder::functions is a good place to start).

@sgrif sgrif added documentation good first issue labels Sep 20, 2017

@notryanb

This comment has been minimized.

Sign in to view
Contributor

notryanb commented Sep 25, 2017

I'd like to start working on this, if no one else has already claimed. I'm also open to working with someone if they would like to help out.

@killercup killercup added the assigned label Sep 25, 2017

@killercup killercup assigned notryanb Sep 25, 2017

notryanb added a commit to notryanb/diesel that referenced this issue Sep 27, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
c9ea29b

notryanb added a commit to notryanb/diesel that referenced this issue Sep 27, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
1dc17d9

notryanb added a commit to notryanb/diesel that referenced this issue Sep 29, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
6a00780

@notryanb notryanb referenced this issue Sep 29, 2017

Merged

Update old api docs #1219

notryanb added a commit to notryanb/diesel that referenced this issue Sep 29, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
28bfe41

notryanb added a commit to notryanb/diesel that referenced this issue Oct 3, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
00029e3

notryanb added a commit to notryanb/diesel that referenced this issue Oct 3, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
34362f0
@weiznich

This comment has been minimized.

Sign in to view
Contributor

weiznich commented Oct 8, 2017

Also the docs for associations seems to be out of date.

For example they are talking about using #[belongs_to(table)] but not about using the joinable!() macro. (The first is not needed anymore, the second is required now…)
@notryanb

This comment has been minimized.

Sign in to view
Contributor

notryanb commented Oct 8, 2017

@weiznich - Good point. I have an issue open - #1235 addressing the associations docs (mostly just the examples), but I'll adjust the explanations as well.

notryanb added a commit to notryanb/diesel that referenced this issue Oct 9, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
823cd31

notryanb added a commit to notryanb/diesel that referenced this issue Oct 9, 2017

@notryanb
Update old api docs 
This commit focuses on the public api for commonly used query and dsl methods.
Revisions included changes to make wording more succinct,
update definitions,
and add new examples / doc-tests where they were lacking.

Fixes diesel-rs#1180
bceef1d

@sgrif sgrif closed this in #1219 Oct 22, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment