Skip to content

Commit 168f4af

Browse files
rsdoielrsdoiel
committed
documentation tweaks, debugging csvfind
1 parent 1f103e1 commit 168f4af

22 files changed

+96
-30
lines changed

‎docs/csv2json.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ul>
1414
<li><a href="/">Home</a></li>
1515
<li><a href="../">up</a></li>
16+
<li><a href="./">Documentation</a></li>
1617
<li><a href="csv2json.html">csv2json</a></li>
1718
<li><a href="csv2mdtable.html">csv2mdtable</a></li>
1819
<li><a href="csv2xlsx.html">csv2xlsx</a></li>
@@ -28,7 +29,9 @@
2829
</nav>
2930

3031
<section>
31-
<h1>USAGE</h1>
32+
<h1>csv2json</h1>
33+
34+
<h2>USAGE</h2>
3235

3336
<pre><code>csv2json [OPTIONS]
3437
</code></pre>

‎docs/csv2json.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11

2-
# USAGE
2+
# csv2json
3+
4+
## USAGE
35

46
csv2json [OPTIONS]
57

‎docs/csv2mdtable.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ul>
1414
<li><a href="/">Home</a></li>
1515
<li><a href="../">up</a></li>
16+
<li><a href="./">Documentation</a></li>
1617
<li><a href="csv2json.html">csv2json</a></li>
1718
<li><a href="csv2mdtable.html">csv2mdtable</a></li>
1819
<li><a href="csv2xlsx.html">csv2xlsx</a></li>
@@ -28,7 +29,9 @@
2829
</nav>
2930

3031
<section>
31-
<h1>USAGE</h1>
32+
<h1>csv2mdtable</h1>
33+
34+
<h2>USAGE</h2>
3235

3336
<pre><code>csv2mdtable [OPTIONS]
3437
</code></pre>

‎docs/csv2mdtable.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11

2-
# USAGE
2+
# csv2mdtable
3+
4+
## USAGE
35

46
csv2mdtable [OPTIONS]
57

‎docs/csv2xlsx.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ul>
1414
<li><a href="/">Home</a></li>
1515
<li><a href="../">up</a></li>
16+
<li><a href="./">Documentation</a></li>
1617
<li><a href="csv2json.html">csv2json</a></li>
1718
<li><a href="csv2mdtable.html">csv2mdtable</a></li>
1819
<li><a href="csv2xlsx.html">csv2xlsx</a></li>
@@ -28,7 +29,9 @@
2829
</nav>
2930

3031
<section>
31-
<h1>USAGE</h1>
32+
<h1>csv2xlsx</h1>
33+
34+
<h2>USAGE</h2>
3235

3336
<pre><code>csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
3437
</code></pre>

‎docs/csv2xlsx.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11

2-
# USAGE
2+
# csv2xlsx
3+
4+
## USAGE
35

46
csv2xlsx [OPTIONS] WORKBOOK_NAME SHEET_NAME
57

‎docs/csvcols.html‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ul>
1414
<li><a href="/">Home</a></li>
1515
<li><a href="../">up</a></li>
16+
<li><a href="./">Documentation</a></li>
1617
<li><a href="csv2json.html">csv2json</a></li>
1718
<li><a href="csv2mdtable.html">csv2mdtable</a></li>
1819
<li><a href="csv2xlsx.html">csv2xlsx</a></li>
@@ -28,7 +29,9 @@
2829
</nav>
2930

3031
<section>
31-
<h1>USAGE</h1>
32+
<h1>csvcols</h1>
33+
34+
<h2>USAGE</h2>
3235

3336
<pre><code>csvcols [OPTIONS] ARGS_AS_COLS
3437
</code></pre>

‎docs/csvcols.md‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# USAGE
1+
2+
# csvcols
3+
4+
## USAGE
25

36
csvcols [OPTIONS] ARGS_AS_COLS
47

‎docs/csvfind.html‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
<ul>
1414
<li><a href="/">Home</a></li>
1515
<li><a href="../">up</a></li>
16+
<li><a href="./">Documentation</a></li>
1617
<li><a href="csv2json.html">csv2json</a></li>
1718
<li><a href="csv2mdtable.html">csv2mdtable</a></li>
1819
<li><a href="csv2xlsx.html">csv2xlsx</a></li>
@@ -28,7 +29,9 @@
2829
</nav>
2930

3031
<section>
31-
<h1>USAGE</h1>
32+
<h1>csvfind</h1>
33+
34+
<h2>USAGE</h2>
3235

3336
<pre><code>csvfind [OPTIONS] TEXT_TO_MATCH
3437
</code></pre>
@@ -43,6 +46,7 @@ <h2>OPTIONS</h2>
4346
<pre><code> -append-edit-distance append column with edit distance found (useful for tuning levenshtein)
4447
-case-sensitive perform a case sensitive match (default is false)
4548
-col column to search for match in the CSV file
49+
-contains use contains phrase for matching
4650
-delete-cost set the delete cost to use for levenshtein matching
4751
-h display help
4852
-help display help
@@ -66,19 +70,24 @@ <h2>EXAMPLES</h2>
6670

6771
<p>Find the rows where the third column matches &ldquo;The Red Book of Westmarch&rdquo; exactly</p>
6872

69-
<pre><code class="language-shell"> csvfind -i books.csv -col=2 &quot;The Red Book of Westmarch&quot;
73+
<pre><code class="language-shell"> csvfind -i books.csv -col=1 &quot;The Red Book of Westmarch&quot;
7074
</code></pre>
7175

72-
<p>Find the rows where the third column matches approximately &ldquo;The Red Book of Westmarch&rdquo;</p>
76+
<p>Find the rows where the third column (colums numbered 0,1,2) matches approximately
77+
&ldquo;The Red Book of Westmarch&rdquo;</p>
7378

74-
<pre><code class="language-shell"> csvfind -i books.csv -col=2 -levenshtein \
79+
<pre><code class="language-shell"> csvfind -i books.csv -col=1 -levenshtein \
7580
-insert-cost=1 -delete-cost=1 -substitute-cost=3 \
7681
-max-edit-distance=50 -append-edit-distance \
7782
&quot;The Red Book of Westmarch&quot;
7883
</code></pre>
7984

80-
<p>In this example all records from the demo books.csv file would be returned with their
81-
distance number as the final column.</p>
85+
<p>In this example we&rsquo;ve appended the edit distance to see how close the matches are.</p>
86+
87+
<p>You can also search for phrases in columns.</p>
88+
89+
<pre><code class="language-shell"> csvfind -i books.csv -col=1 -contains &quot;Red Book&quot;
90+
</code></pre>
8291

8392
</section>
8493

‎docs/csvfind.md‎

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11

2-
# USAGE
2+
# csvfind
3+
4+
## USAGE
35

46
csvfind [OPTIONS] TEXT_TO_MATCH
57

@@ -14,6 +16,7 @@ with matched text. Supports exact match as well as some Levenshtein matching.
1416
-append-edit-distance append column with edit distance found (useful for tuning levenshtein)
1517
-case-sensitive perform a case sensitive match (default is false)
1618
-col column to search for match in the CSV file
19+
-contains use contains phrase for matching
1720
-delete-cost set the delete cost to use for levenshtein matching
1821
-h display help
1922
-help display help
@@ -38,18 +41,24 @@ with matched text. Supports exact match as well as some Levenshtein matching.
3841
Find the rows where the third column matches "The Red Book of Westmarch" exactly
3942

4043
```shell
41-
csvfind -i books.csv -col=2 "The Red Book of Westmarch"
44+
csvfind -i books.csv -col=1 "The Red Book of Westmarch"
4245
```
4346

44-
Find the rows where the third column matches approximately "The Red Book of Westmarch"
47+
Find the rows where the third column (colums numbered 0,1,2) matches approximately
48+
"The Red Book of Westmarch"
4549

4650
```shell
47-
csvfind -i books.csv -col=2 -levenshtein \
51+
csvfind -i books.csv -col=1 -levenshtein \
4852
-insert-cost=1 -delete-cost=1 -substitute-cost=3 \
4953
-max-edit-distance=50 -append-edit-distance \
5054
"The Red Book of Westmarch"
5155
```
5256

53-
In this example all records from the demo books.csv file would be returned with their
54-
distance number as the final column.
57+
In this example we've appended the edit distance to see how close the matches are.
58+
59+
You can also search for phrases in columns.
60+
61+
```shell
62+
csvfind -i books.csv -col=1 -contains "Red Book"
63+
```
5564

0 commit comments

Comments
 (0)