kallithea Changeset - 07644836640a

Changeset - 07644836640a

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Thomas De Schampheleire - 9 years ago 2017-01-14 21:42:30
thomas.de.schampheleire@gmail.com

model: remove docstring code example

This type of code examples are not present in other files.
It is unclear whether this example is still accurate.
And it is equally unclear whether they provide real value compared to 'real'
code.

Remove it.

1 file changed with 0 insertions and 18 deletions:

kallithea/model/base.py

0 comments (0 inline, 0 general)

kallithea/model/base.py

➞

Show inline comments

@@ @@ -2,66 +2,48 @@ @@
 # This program is free software: you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
 # the Free Software Foundation, either version 3 of the License, or
 # (at your option) any later version.
+#
 # This program is distributed in the hope that it will be useful,
 # but WITHOUT ANY WARRANTY; without even the implied warranty of
 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 # GNU General Public License for more details.
+#
 # You should have received a copy of the GNU General Public License
 # along with this program.  If not, see <http://www.gnu.org/licenses/>.
 """
 kallithea.model.base
 ~~~~~~~~~~~~~~~~~~~~
 The application's model objects
 This file was forked by the Kallithea project in July 2014.
 Original author and date, and relevant copyright and licensing information is below:
 :created_on: Nov 25, 2010
 :author: marcink
 :copyright: (c) 2013 RhodeCode GmbH, and others.
 :license: GPLv3, see LICENSE.md for more details.
 :example:
     .. code-block:: python
        from paste.deploy import appconfig
        from pylons import config
        from sqlalchemy import engine_from_config
        from kallithea.config.environment import load_environment
        conf = appconfig('config:development.ini', relative_to = './../../')
        load_environment(conf.global_conf, conf.local_conf)
        engine = engine_from_config(config, 'sqlalchemy.')
        init_model(engine)
        # RUN YOUR CODE HERE
 """
 import logging
 from kallithea.model import meta
 from kallithea.lib.utils2 import obfuscate_url_pw
 log = logging.getLogger(__name__)
 def init_model(engine):
     """
     Initializes db session, bind the engine with the metadata,
     Call this before using any of the tables or classes in the model,
     preferably once in application start
     :param engine: engine to bind to
     """
     engine_str = obfuscate_url_pw(str(engine.url))
     log.info("initializing db for %s", engine_str)
     meta.Base.metadata.bind = engine
 class BaseModel(object):

0 comments (0 inline, 0 general)