From: Christopher Allan Webber Date: Mon, 23 Jun 2014 18:45:00 +0000 (-0500) Subject: Removing legacy mongo-related docstring X-Git-Url: https://vcs.fsf.org/?a=commitdiff_plain;h=27f99327313bda0dc5cebdb56d29a3347be1ac34;p=mediagoblin.git Removing legacy mongo-related docstring --- diff --git a/mediagoblin/db/__init__.py b/mediagoblin/db/__init__.py index 27ca4b06..719b56e7 100644 --- a/mediagoblin/db/__init__.py +++ b/mediagoblin/db/__init__.py @@ -14,36 +14,3 @@ # You should have received a copy of the GNU Affero General Public License # along with this program. If not, see . -""" -Database Abstraction/Wrapper Layer -================================== - -This submodule is for most of the db specific stuff. - -There are two main ideas here: - -1. Open up a small possibility to replace mongo by another - db. This means, that all direct mongo accesses should - happen in the db submodule. While all the rest uses an - API defined by this submodule. - - Currently this API happens to be basicly mongo. - Which means, that the abstraction/wrapper layer is - extremely thin. - -2. Give the rest of the app a simple and easy way to get most of - their db needs. Which often means some simple import - from db.util. - -What does that mean? - -* Never import mongo directly outside of this submodule. - -* Inside this submodule you can do whatever is needed. The - API border is exactly at the submodule layer. Nowhere - else. - -* helper functions can be moved in here. They become part - of the db.* API - -"""