Skip to content

Commit d69f1c0

Browse files
shagunsodhanijhermann
authored andcommitted
Fix grammatical error in documentation (close #170) (#175)
* fixed #170 * fixed some typos
1 parent 17f06a5 commit d69f1c0

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

docs/configobj.html

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1880,8 +1880,7 @@ <h1><a class="toc-backref" href="#id78">10&nbsp;&nbsp;&nbsp;Empty values</a></h1
18801880
<div class="section" id="unrepr-mode">
18811881
<h1><a class="toc-backref" href="#id79">11&nbsp;&nbsp;&nbsp;unrepr mode</a></h1>
18821882
<p>The <tt class="docutils literal">unrepr</tt> option allows you to store and retrieve the basic Python
1883-
data-types using config files. It has to use a slightly different syntax to
1884-
normal ConfigObj files. Unsurprisingly it uses Python syntax.</p>
1883+
data-types using config files. It has to use a slightly different syntax as compared to normal ConfigObj files though it is still Python syntax.</p>
18851884
<p>This means that lists are different (they are surrounded by square brackets),
18861885
and strings <em>must</em> be quoted.</p>
18871886
<p>The types that <tt class="docutils literal">unrepr</tt> can work with are :</p>
@@ -1897,7 +1896,7 @@ <h1><a class="toc-backref" href="#id79">11&nbsp;&nbsp;&nbsp;unrepr mode</a></h1>
18971896
<p><tt class="docutils literal">unrepr</tt> uses <tt class="docutils literal">repr(object)</tt> to write out values, so it currently <em>doesn't</em>
18981897
check that you are writing valid objects. If you attempt to read an unsupported
18991898
value, ConfigObj will raise a <tt class="docutils literal">configobj.UnknownType</tt> exception.</p>
1900-
<p>Values that are triple quoted cased. The triple quotes are removed <em>before</em>
1899+
<p>Values that are enclosed in triple quotes are handlded as a special case. The triple quotes are removed <em>before</em>
19011900
converting. This means that you can use triple quotes to write dictionaries
19021901
over several lines in your config files. They won't be written like this
19031902
though.</p>

docs/configobj.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1957,8 +1957,8 @@ unrepr mode
19571957
===========
19581958

19591959
The ``unrepr`` option allows you to store and retrieve the basic Python
1960-
data-types using config files. It has to use a slightly different syntax to
1961-
normal ConfigObj files. Unsurprisingly it uses Python syntax.
1960+
data-types using config files. It has to use a slightly different syntax as compared to
1961+
normal ConfigObj files though it is still Python syntax.
19621962

19631963
This means that lists are different (they are surrounded by square brackets),
19641964
and strings *must* be quoted.

0 commit comments

Comments
 (0)