Commit 02c0a3d2 authored by Kirill Smelkov's avatar Kirill Smelkov

go/zodb: Pkgdoc cosmetics

- change "types, interfaces and errors" to API in the header.
- it is not only data model, but also API that is tried to be reasonable
  compatible with ZODB/py.
- an article before "the" transaction is better.
parent eccef981
...@@ -17,10 +17,10 @@ ...@@ -17,10 +17,10 @@
// See COPYING file for full licensing terms. // See COPYING file for full licensing terms.
// See https://www.nexedi.com/licensing for rationale and options. // See https://www.nexedi.com/licensing for rationale and options.
// Package zodb defines types, interfaces and errors to work with ZODB databases. // Package zodb provides API to work with ZODB databases.
// //
// ZODB (http://zodb.org) was originally created in Python world by Jim Fulton et al. // ZODB (http://zodb.org) was originally created in Python world by Jim Fulton et al.
// Data model this package provides is partly based on ZODB/py // Data model and API this package provides are partly based on ZODB/py
// (https://github.com/zopefoundation/ZODB) to maintain compatibility in // (https://github.com/zopefoundation/ZODB) to maintain compatibility in
// between Python and Go implementations. // between Python and Go implementations.
// //
...@@ -31,7 +31,7 @@ ...@@ -31,7 +31,7 @@
// several objects and also has metadata, like user and description, associated // several objects and also has metadata, like user and description, associated
// with it. If an object is changed by transaction, it is said that there is // with it. If an object is changed by transaction, it is said that there is
// revision of the object with particular object state committed by that transaction. // revision of the object with particular object state committed by that transaction.
// Object revision is the same as tid of transaction that modified the object. // Object revision is the same as tid of the transaction that modified the object.
// The combination of object identifier and particular revision (serial) // The combination of object identifier and particular revision (serial)
// uniquely addresses corresponding data record. // uniquely addresses corresponding data record.
// //
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment