Skip to content
This repository was archived by the owner on May 9, 2020. It is now read-only.

Commit c155e95

Browse files
author
Alexis Aubry Radanovic
committed
Fix wrong example in README and docs
1 parent 1988d02 commit c155e95

File tree

11 files changed

+34
-28
lines changed

11 files changed

+34
-28
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# QuerySerialization Change Log
22

3+
## 2016-12-03 — Version 1.0.1
4+
5+
- Fix wrong example in README and documentation
6+
37
## 2016-12-03 — Version 1.0.0
48

59
- Encode queries from dictionaries

‎QuerySerialization.podspec‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Pod::Spec.new do |s|
22
s.name = "QuerySerialization"
3-
s.version = "1.0.0"
3+
s.version = "1.0.1"
44
s.summary = "Encode and Decode Query Strings in Swift"
55
s.description = <<-DESC
66
QuerySerialization allows you to encode dictionaries into query strings, and to decode query strings to dictionaries. It also supports automatic percent encoding/decoding.

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -84,7 +84,7 @@ To decode a query string into a Dictionary, call:
8484

8585
~~~swift
8686
let queryString = "key=value&message=Hello%20world"
87-
let queryElements = QueryElements.decode(queryString: queryString)
87+
let queryElements = QuerySerialization.decode(queryString: queryString)
8888

8989
// queryElements = ["key":"value","message":"Hello world"]
9090
~~~
@@ -93,7 +93,7 @@ If a key or value contains percent encoding, it will be removed automatically. Y
9393

9494
~~~swift
9595
let queryString = "key=value&message=Hello%20world"
96-
let queryElements = QueryElements.decode(queryString: queryString, removePercentEncoding: false)
96+
let queryElements = QuerySerialization.decode(queryString: queryString, removePercentEncoding: false)
9797

9898
// queryElements = ["key":"value","message":"Hello%20world"]
9999
~~~

‎docs/Classes.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div class="content-wrapper">
1616
<p><a href="index.html">QuerySerialization Docs</a> (100% documented)</p>
1717
<p class="header-right"><a href="https://github.com/alexaubry/QuerySerialization"><img src="img/gh.png"/>View on GitHub</a></p>
18-
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Ecom%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
18+
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
1919
</div>
2020
</header>
2121
<div class="content-wrapper">
@@ -74,7 +74,7 @@ <h4>Declaration</h4>
7474
</div>
7575
</div>
7676
<div class="slightly-smaller">
77-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L41-L174">Show on GitHub</a>
77+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L41-L174">Show on GitHub</a>
7878
</div>
7979
</section>
8080
</div>
@@ -84,7 +84,7 @@ <h4>Declaration</h4>
8484
</section>
8585
</section>
8686
<section id="footer">
87-
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis Aubry Radanovic</a>. All rights reserved. (Last updated: 2016-12-02)</p>
87+
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis</a>. All rights reserved. (Last updated: 2016-12-03)</p>
8888
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
8989
</section>
9090
</article>

‎docs/Classes/QuerySerialization.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<div class="content-wrapper">
1717
<p><a href="../index.html">QuerySerialization Docs</a> (100% documented)</p>
1818
<p class="header-right"><a href="https://github.com/alexaubry/QuerySerialization"><img src="../img/gh.png"/>View on GitHub</a></p>
19-
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Ecom%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
19+
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
2020
</div>
2121
</header>
2222
<div class="content-wrapper">
@@ -131,7 +131,7 @@ <h4>Return Value</h4>
131131

132132
</div>
133133
<div class="slightly-smaller">
134-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L56-L74">Show on GitHub</a>
134+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L56-L74">Show on GitHub</a>
135135
</div>
136136
</section>
137137
</div>
@@ -216,7 +216,7 @@ <h4>Return Value</h4>
216216

217217
</div>
218218
<div class="slightly-smaller">
219-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L89-L133">Show on GitHub</a>
219+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L89-L133">Show on GitHub</a>
220220
</div>
221221
</section>
222222
</div>
@@ -226,7 +226,7 @@ <h4>Return Value</h4>
226226
</section>
227227
</section>
228228
<section id="footer">
229-
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis Aubry Radanovic</a>. All rights reserved. (Last updated: 2016-12-02)</p>
229+
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis</a>. All rights reserved. (Last updated: 2016-12-03)</p>
230230
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
231231
</section>
232232
</article>

‎docs/docsets/QuerySerialization.docset/Contents/Resources/Documents/Classes.html‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div class="content-wrapper">
1616
<p><a href="index.html">QuerySerialization Docs</a> (100% documented)</p>
1717
<p class="header-right"><a href="https://github.com/alexaubry/QuerySerialization"><img src="img/gh.png"/>View on GitHub</a></p>
18-
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Ecom%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
18+
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
1919
</div>
2020
</header>
2121
<div class="content-wrapper">
@@ -74,7 +74,7 @@ <h4>Declaration</h4>
7474
</div>
7575
</div>
7676
<div class="slightly-smaller">
77-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L41-L174">Show on GitHub</a>
77+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L41-L174">Show on GitHub</a>
7878
</div>
7979
</section>
8080
</div>
@@ -84,7 +84,7 @@ <h4>Declaration</h4>
8484
</section>
8585
</section>
8686
<section id="footer">
87-
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis Aubry Radanovic</a>. All rights reserved. (Last updated: 2016-12-02)</p>
87+
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis</a>. All rights reserved. (Last updated: 2016-12-03)</p>
8888
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
8989
</section>
9090
</article>

‎docs/docsets/QuerySerialization.docset/Contents/Resources/Documents/Classes/QuerySerialization.html‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
<div class="content-wrapper">
1717
<p><a href="../index.html">QuerySerialization Docs</a> (100% documented)</p>
1818
<p class="header-right"><a href="https://github.com/alexaubry/QuerySerialization"><img src="../img/gh.png"/>View on GitHub</a></p>
19-
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Ecom%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
19+
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="../img/dash.png"/>Install in Dash</a></p>
2020
</div>
2121
</header>
2222
<div class="content-wrapper">
@@ -131,7 +131,7 @@ <h4>Return Value</h4>
131131

132132
</div>
133133
<div class="slightly-smaller">
134-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L56-L74">Show on GitHub</a>
134+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L56-L74">Show on GitHub</a>
135135
</div>
136136
</section>
137137
</div>
@@ -216,7 +216,7 @@ <h4>Return Value</h4>
216216

217217
</div>
218218
<div class="slightly-smaller">
219-
<a href="https://github.com/alexaubry/QuerySerialization/realm-cocoa/tree/1.0.0/Sources/QuerySerialization.swift#L89-L133">Show on GitHub</a>
219+
<a href="https://github.com/alexaubry/QuerySerialization/tree/master/Sources/QuerySerialization.swift#L89-L133">Show on GitHub</a>
220220
</div>
221221
</section>
222222
</div>
@@ -226,7 +226,7 @@ <h4>Return Value</h4>
226226
</section>
227227
</section>
228228
<section id="footer">
229-
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis Aubry Radanovic</a>. All rights reserved. (Last updated: 2016-12-02)</p>
229+
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis</a>. All rights reserved. (Last updated: 2016-12-03)</p>
230230
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
231231
</section>
232232
</article>

‎docs/docsets/QuerySerialization.docset/Contents/Resources/Documents/index.html‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
<div class="content-wrapper">
1616
<p><a href="index.html">QuerySerialization Docs</a> (100% documented)</p>
1717
<p class="header-right"><a href="https://github.com/alexaubry/QuerySerialization"><img src="img/gh.png"/>View on GitHub</a></p>
18-
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Ecom%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
18+
<p class="header-right"><a href="dash-feed://https%3A%2F%2Falexaubry%2Egithub%2Eio%2FQuerySerialization%2Fdocsets%2FQuerySerialization%2Exml"><img src="img/dash.png"/>Install in Dash</a></p>
1919
</div>
2020
</header>
2121
<div class="content-wrapper">
@@ -46,7 +46,8 @@
4646

4747
<p><img src="https://img.shields.io/badge/Swift-3.0.1-ee4f37.svg" alt="Swift 3.0.1">
4848
<img src="https://img.shields.io/badge/License-MIT-000000.svg" alt="License">
49-
<a href=""><img src="https://img.shields.io/cocoapods/v/QuerySerialization.svg" alt="CocoaPods"></a>
49+
<a href="https://cocoapods.org/pods/QuerySerialization"><img src="https://img.shields.io/cocoapods/v/QuerySerialization.svg" alt="CocoaPods"></a>
50+
<a href="https://github.com/Carthage/Carthage"><img src="https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat" alt="Carthage compatible"></a>
5051
<a href="https://travis-ci.org/alexaubry/QuerySerialization"><img src="https://travis-ci.org/alexaubry/QuerySerialization.svg?branch=master" alt="Build Status"></a>
5152
<a href="https://codecov.io/gh/alexaubry/QuerySerialization"><img src="https://codecov.io/gh/alexaubry/QuerySerialization/branch/master/graph/badge.svg" alt="codecov"></a>
5253
<a href="https://twitter.com/leksantoine"><img src="https://img.shields.io/badge/Twitter-%40leksantoine-6C7A89.svg" alt="Twitter : @leksantoine"></a></p>
@@ -104,22 +105,22 @@
104105

105106
<p>To decode a query string into a Dictionary, call:</p>
106107
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">queryString</span> <span class="o">=</span> <span class="s">"key=value&amp;message=Hello%20world"</span>
107-
<span class="k">let</span> <span class="nv">queryElements</span> <span class="o">=</span> <span class="kt">QueryElements</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="nv">queryString</span><span class="p">:</span> <span class="n">queryString</span><span class="p">)</span>
108+
<span class="k">let</span> <span class="nv">queryElements</span> <span class="o">=</span> <span class="kt">QuerySerialization</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="nv">queryString</span><span class="p">:</span> <span class="n">queryString</span><span class="p">)</span>
108109

109110
<span class="c1">// queryElements = ["key":"value","message":"Hello world"]</span>
110111
</code></pre>
111112

112113
<p>If a key or value contains percent encoding, it will be removed automatically. You can opt-out this feature by using this instead:</p>
113114
<pre class="highlight swift"><code><span class="k">let</span> <span class="nv">queryString</span> <span class="o">=</span> <span class="s">"key=value&amp;message=Hello%20world"</span>
114-
<span class="k">let</span> <span class="nv">queryElements</span> <span class="o">=</span> <span class="kt">QueryElements</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="nv">queryString</span><span class="p">:</span> <span class="n">queryString</span><span class="p">,</span> <span class="nv">removePercentEncoding</span><span class="p">:</span> <span class="kc">false</span><span class="p">)</span>
115+
<span class="k">let</span> <span class="nv">queryElements</span> <span class="o">=</span> <span class="kt">QuerySerialization</span><span class="o">.</span><span class="nf">decode</span><span class="p">(</span><span class="nv">queryString</span><span class="p">:</span> <span class="n">queryString</span><span class="p">,</span> <span class="nv">removePercentEncoding</span><span class="p">:</span> <span class="kc">false</span><span class="p">)</span>
115116

116117
<span class="c1">// queryElements = ["key":"value","message":"Hello%20world"]</span>
117118
</code></pre>
118119

119120
</section>
120121
</section>
121122
<section id="footer">
122-
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis Aubry Radanovic</a>. All rights reserved. (Last updated: 2016-12-02)</p>
123+
<p>&copy; 2016 <a class="link" href="https://github.com/alexaubry" target="_blank" rel="external">Alexis</a>. All rights reserved. (Last updated: 2016-12-03)</p>
123124
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.7.2</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
124125
</section>
125126
</article>

‎docs/docsets/QuerySerialization.tgz‎

13 Bytes
Binary file not shown.

‎docs/docsets/QuerySerialization.xml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
<entry><version>1.0.0</version><url>https://alexaubry.github.com/QuerySerialization/docsets/QuerySerialization.tgz</url></entry>
1+
<entry><version>1.0.1</version><url>https://alexaubry.github.io/QuerySerialization/docsets/QuerySerialization.tgz</url></entry>

0 commit comments

Comments
 (0)