Merge lp://staging/~thisfred/u1db/documentation5 into lp://staging/u1db
Proposed by
Eric Casteleijn
Status: | Merged |
---|---|
Approved by: | Eric Casteleijn |
Approved revision: | 389 |
Merged at revision: | 387 |
Proposed branch: | lp://staging/~thisfred/u1db/documentation5 |
Merge into: | lp://staging/u1db |
Diff against target: |
767 lines (+412/-101) 6 files modified
cosas/cosas.py (+10/-17) cosas/test_cosas.py (+2/-2) cosas/ui.py (+2/-0) html-docs/high-level-api.rst (+66/-51) html-docs/tutorial.rst (+305/-10) u1db/__init__.py (+27/-21) |
To merge this branch: | bzr merge lp://staging/~thisfred/u1db/documentation5 |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
Stuart Langridge (community) | Approve | ||
Review via email:
|
Commit message
Finished first version of the Cosas based tutorial.
Description of the change
Finished first version of the Cosas based tutorial.
To post a comment you must log in.
When syncronising over http(s) servers can (and usually will) require OAuth -> When synchronising over http(s), servers can (and usually will) require OAuth
The section about editing docs (":py:meth: `~u1db. Database. put_doc` takes a :py:class: `~u1db. Document` object, because the object encapsulates revision information for a particular document") should, I think, say something like "the u1db.Document object is what you get from get_doc", so that people know what a Document object is. However, get_doc is described *after* put_doc. The get_doc bit also doesn't explain that it returns a Document at all. This whole section probably needs changing to reflect that (almost) everything is done with Document objects, you get a Document from get_doc, and you save that Document object back after making changes with it, so the procedure for altering an existing db entry is get_doc, edit the returned Document, put_doc it.
The section on the tags index ("The ``tags`` index will index any document that has a top level field ``tags`` and index its value.") could benefit from an example showing that a document with tags ["shopping", "food"] goes into the index twice. (I know this is explained in more detail elsewhere, but it'd be handy to help people understand if it's presented in context.)