Removing legacy mongo-related docstring
authorChristopher Allan Webber <cwebber@dustycloud.org>
Mon, 23 Jun 2014 18:45:00 +0000 (13:45 -0500)
committerChristopher Allan Webber <cwebber@dustycloud.org>
Mon, 23 Jun 2014 18:45:00 +0000 (13:45 -0500)
mediagoblin/db/__init__.py

index 27ca4b06547fb0fd8cdca37e63b4eb38e49bda62..719b56e7c231319f077d06ed4a036bc571d41fc8 100644 (file)
 # You should have received a copy of the GNU Affero General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 
-"""
-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
-
-"""