Skip to content

Commit 160c241

Browse files
authored
[DOC] Fix wrong formatting in README (#127)
1 parent 81817eb commit 160c241

3 files changed

Lines changed: 27 additions & 28 deletions

File tree

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -243,11 +243,15 @@ FROM table1
243243
WHERE field1 = 1
244244
and field2 <= 2
245245
or field3 = 5
246-
ORDER BY field1
246+
ORDER BY field1;
247247
```
248+
248249
> This is a very nice, easy example but things can become more complicated if comments come into play
249250
250-
4. Subqueries are also properly indented, e.g.:```sqlSELECT a.field1,
251+
4. Subqueries are also properly indented, e.g.
252+
253+
```sql
254+
SELECT a.field1,
251255
a.field2,
252256
b.field3
253257
FROM (SELECT field1,
@@ -257,7 +261,7 @@ FROM (SELECT field1,
257261
LEFT JOIN (SELECT field1,
258262
field3
259263
FROM table2) as b
260-
ON a.field1 = b.field1:
264+
ON a.field1 = b.field1;
261265
```
262266

263267
5. Everything not being a query of the form `CREATE ... TABLE / VIEW` or `SELECT ...` is left unchanged

docs/index.html

Lines changed: 17 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -421,32 +421,27 @@ <h2 id="Formatting-Logic">Formatting Logic<a class="anchor-link" href="#Formatti
421421
<span class="k">WHERE</span> <span class="n">field1</span> <span class="o">=</span> <span class="mi">1</span>
422422
<span class="k">and</span> <span class="n">field2</span> <span class="o">&lt;=</span> <span class="mi">2</span>
423423
<span class="k">or</span> <span class="n">field3</span> <span class="o">=</span> <span class="mi">5</span>
424-
<span class="k">ORDER</span> <span class="k">BY</span> <span class="n">field1</span>
424+
<span class="k">ORDER</span> <span class="k">BY</span> <span class="n">field1</span><span class="p">;</span>
425425
</pre></div>
426426
<blockquote><p>This is a very nice, easy example but things can become more complicated if comments come into play</p>
427427
</blockquote>
428428
<ol>
429-
<li><p>Subqueries are also properly indented, e.g.:```sqlSELECT a.field1,</p>
430-
431-
<pre><code>a.field2,
432-
b.field3
433-
</code></pre>
434-
<p>FROM (SELECT field1,</p>
435-
436-
<pre><code> field2
437-
FROM table1
438-
WHERE field1 = 1) as a
439-
</code></pre>
440-
<p>LEFT JOIN (SELECT field1,</p>
441-
442-
<pre><code> field3
443-
FROM table2) as b
444-
ON a.field1 = b.field1:
445-
</code></pre>
446-
<p>```</p>
447-
</li>
448-
<li><p>Everything not being a query of the form <code>CREATE ... TABLE / VIEW</code> or <code>SELECT ...</code> is left unchanged</p>
449-
</li>
429+
<li>Subqueries are also properly indented, e.g.</li>
430+
</ol>
431+
<div class="highlight"><pre><span></span><span class="k">SELECT</span> <span class="n">a</span><span class="p">.</span><span class="n">field1</span><span class="p">,</span>
432+
<span class="n">a</span><span class="p">.</span><span class="n">field2</span><span class="p">,</span>
433+
<span class="n">b</span><span class="p">.</span><span class="n">field3</span>
434+
<span class="k">FROM</span> <span class="p">(</span><span class="k">SELECT</span> <span class="n">field1</span><span class="p">,</span>
435+
<span class="n">field2</span>
436+
<span class="k">FROM</span> <span class="n">table1</span>
437+
<span class="k">WHERE</span> <span class="n">field1</span> <span class="o">=</span> <span class="mi">1</span><span class="p">)</span> <span class="k">as</span> <span class="n">a</span>
438+
<span class="k">LEFT</span> <span class="k">JOIN</span> <span class="p">(</span><span class="k">SELECT</span> <span class="n">field1</span><span class="p">,</span>
439+
<span class="n">field3</span>
440+
<span class="k">FROM</span> <span class="n">table2</span><span class="p">)</span> <span class="k">as</span> <span class="n">b</span>
441+
<span class="k">ON</span> <span class="n">a</span><span class="p">.</span><span class="n">field1</span> <span class="o">=</span> <span class="n">b</span><span class="p">.</span><span class="n">field1</span><span class="p">;</span>
442+
</pre></div>
443+
<ol>
444+
<li>Everything not being a query of the form <code>CREATE ... TABLE / VIEW</code> or <code>SELECT ...</code> is left unchanged</li>
450445
</ol>
451446

452447
</div>

nbs/index.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -374,12 +374,12 @@
374374
"WHERE field1 = 1\n",
375375
" and field2 <= 2\n",
376376
" or field3 = 5\n",
377-
"ORDER BY field1\n",
377+
"ORDER BY field1;\n",
378378
"```\n",
379379
"\n",
380380
"> This is a very nice, easy example but things can become more complicated if comments come into play\n",
381381
"\n",
382-
"4. Subqueries are also properly indented, e.g.:\n",
382+
"4. Subqueries are also properly indented, e.g.\n",
383383
"\n",
384384
"```sql\n",
385385
"SELECT a.field1,\n",
@@ -392,7 +392,7 @@
392392
" LEFT JOIN (SELECT field1,\n",
393393
" field3\n",
394394
" FROM table2) as b\n",
395-
" ON a.field1 = b.field1:\n",
395+
" ON a.field1 = b.field1;\n",
396396
"```\n",
397397
"\n",
398398
"5. Everything not being a query of the form `CREATE ... TABLE / VIEW` or `SELECT ...` is left unchanged"

0 commit comments

Comments
 (0)