Issue 198 in couchdb-python: Naming: mapping.Document conflicts with client.Document

[couchdb...@googlecode.com]

Status: New
Owner: ----
Labels: Type-Defect Priority-Medium

New issue 198 by SpaX...@gmail.com: Naming: mapping.Document conflicts with
client.Document
http://code.google.com/p/couchdb-python/issues/detail?id=198

Could we rename

mapping.Document

to

mapping.DocumentMap

to better avoid the naming confusion?

In addition, the documentation at
http://packages.python.org/CouchDB/mapping.html

says (mine emphasised)

To define a document mapping, you declare a Python class inherited from
**Document**, and add any number of Field attributes:

Please change that to

To define a document mapping, you declare a Python class inherited from
**mapping.DocumentMap**, and add any number of Field attributes:

This will probably break a lot of things, and is a breaking change, but
would be nice to see.

[couchdb...@googlecode.com]

Comment #1 on issue 198 by mva.led: Naming: mapping.Document conflicts with
client.Document
http://code.google.com/p/couchdb-python/issues/detail?id=198

I don't really think the name should be changed. However, IMO, the
documentation is not really helpful in this regards. There should be a
topic on What's the difference between couchdb.client.Document and
couchdb.mapping.Document.

This a rather confusing thing at first. Since we may expect some unique
interface to Documents. However, this is a feature I really appreciate:
mappings are designed to cover specific use cases; and not all possible
uses cases. So, having a simple/direct interface to CouchDB json documents
as dicts is really useful thing.

Best regards,
Manuel.

[couchdb...@googlecode.com]

Comment #2 on issue 198 by SpaX...@gmail.com: Naming: mapping.Document

conflicts with client.Document
http://code.google.com/p/couchdb-python/issues/detail?id=198

Thanks Manuel. Even if it's a documentation update, I would greatly
appreciate it, as I lost an hour today trying to figure out why my Document
(from couchdb import Document, who knew?) didn't inherit from the right
methods, and I saw iterkeys()...

[couchdb...@googlecode.com]

Updates:
Status: Accepted
Owner: kxepal
Labels: Component-Docs Milestone-0.9

Comment #3 on issue 198 by kxepal: Naming: mapping.Document conflicts with
client.Document
http://code.google.com/p/couchdb-python/issues/detail?id=198

I suppose explicit Document import in documentation have to solve this
misunderstood.

Attachments:
couchdb-python-198-r1.patch 806 bytes

[couchdb...@googlecode.com]

Updates:
Status: Fixed

Comment #4 on issue 198 by djc.ochtman: Naming: mapping.Document conflicts
with client.Document
http://code.google.com/p/couchdb-python/issues/detail?id=198

I've pushed your patch as revision 911a7e72d8a3, thanks. I think we can
consider this issue fixed!