Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Commit 3c26f6c

Browse files
committed
Update docs
1 parent 68d4302 commit 3c26f6c

7 files changed

+1387
-1296
lines changed

‎devel/DeveloperGuide.html‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -66,22 +66,22 @@ <h1>Development Installation</h1>
6666
<h1>Architecture</h1>
6767
<p>There are four main kinds of objects in SQLObject: tables, columns,
6868
connections and converters.</p>
69-
<p>Tables-related objects are in sqlobject/main.py module. There are two
69+
<p>Tables-related objects are in <ahref="sqlobject/main.py.html" class="reference external">sqlobject/main.py</a> module. There are two
7070
main classes: SQLObject and sqlmeta; the latter is not a metaclass but a
7171
parent class for sqlmeta attribute in every class - the authors tried to
7272
move there all attributes and methods not directly related to columns to
7373
avoid cluttering table namespace.</p>
74-
<p>Columns are instances of classes from sqlobject/col.py. There are two
74+
<p>Columns are instances of classes from <ahref="sqlobject/col.py.html" class="reference external">sqlobject/col.py</a>. There are two
7575
classes for every column: one is for user to include into an instance of
7676
SQLObject, an instance of the other is automatically created by
7777
SQLObject metaclass. The two classes are names SOCol and Col; for
7878
example, SOBoolCol and BoolCol.</p>
7979
<p>Connections are instances of DBConnection class (from
80-
sqlobject/dbconnection.py) and its concrete descendants. DBConnection
80+
<ahref="sqlobject/dbconnection.py.html" class="reference external">sqlobject/dbconnection.py</a>) and its concrete descendants. DBConnection
8181
contains generic code for generating SQL, working with transactions and
8282
so on. Concrete connection classes (like PostgresConnection and
8383
SQLiteConnection) provides backend-specific functionality.</p>
84-
<p>Converters from sqlobject/converters.py aren't visible to the user. They
84+
<p>Converters from <ahref="sqlobject/converters.py.html" class="reference external">sqlobject/converters.py</a> aren't visible to the user. They
8585
are used behind the scene to convert object to SQL strings. The most
8686
elaborated converter there is StringConverters. Yes, it converts strings
8787
to strings. It converts python strings to SQL strings using
@@ -99,7 +99,7 @@ <h1>Style Guide</h1>
9999
<ul>
100100
<li><p class="first"><strong>No tabs</strong>. Not anywhere. Always indent with 4 spaces.</p>
101101
</li>
102-
<li><p class="first">I don't stress too much on line length. But try to break lines up
102+
<li><p class="first">We don't stress too much on line length. But try to break lines up
103103
by grouping with parenthesis instead of with backslashes (if you
104104
can). Do asserts like:</p>
105105
<pre class="literal-block">
@@ -120,7 +120,7 @@ <h1>Style Guide</h1>
120120
sqlobject import *</tt> so names should be fairly distinct, or they
121121
shouldn't be exported in <tt class="docutils literal">sqlobject.__init__</tt>.</p>
122122
</li>
123-
<li><p class="first">I'm very picky about whitespace. There's one and only one right way
123+
<li><p class="first">We're very picky about whitespace. There's one and only one right way
124124
to do it. Good examples:</p>
125125
<pre class="literal-block">
126126
short = 3
@@ -144,9 +144,9 @@ <h1>Style Guide</h1>
144144
func( a, b )
145145
[ 1, 2, 3 ]
146146
</pre>
147-
<p>To me, the poor use of whitespace seems lazy. I'll think less of
148-
your code (justified or not) for this very trivial reason. I will
149-
fix all your code for you if you don't do it yourself, because I
147+
<p>To us, the poor use of whitespace seems lazy. We'll think less of
148+
your code (justified or not) for this very trivial reason. We will
149+
fix all your code for you if you don't do it yourself, because we
150150
can't bear to look at sloppy whitespace.</p>
151151
</li>
152152
<li><p class="first">Use <tt class="docutils literal">@@</tt> to mark something that is suboptimal, or where you have a
@@ -221,8 +221,8 @@ <h1>Testing</h1>
221221
<p>If you <tt class="docutils literal">import *</tt> you'll also get py.test's version of <a href="http://pytest.org/latest/assert.html#assertions-about-expected-exceptions" class="reference external">raises</a>, an
222222
<tt class="docutils literal">inserts</tt> function that can create instances for you, and a couple
223223
miscellaneous functions.</p>
224-
<p>If you submit a patch or implement a feature without a test, I'll be
225-
forced to write the test. That's no fun for me, to just be writing
224+
<p>If you submit a patch or implement a feature without a test, we'll be
225+
forced to write the test. That's no fun for us, to just be writing
226226
tests. So please, write tests; everything at least needs to be
227227
exercised, even if the tests are absolutely complete.</p>
228228
<p>We now use Travis CI to run tests. See the status:</p>

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /