Skip to content

Commit abf898e

Browse files
committed
DOC: Fix up documentation
1 parent c4f7d1a commit abf898e

1 file changed

Lines changed: 22 additions & 20 deletions

File tree

README.md

Lines changed: 22 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
![CI](https://github.com/zbrookle/dataframe_sql/workflows/CI/badge.svg)
44

5+
56
## Installation
67

78
```bash
@@ -72,12 +73,12 @@ INNER, CROSS, FULL OUTER, LEFT OUTER, RIGHT OUTER, FULL, LEFT, RIGHT
7273
Order by and limit:
7374

7475
```SQL
75-
set1
76+
<set>
7677
[ORDER BY <expression>]
7778
[LIMIT <number>]
7879
```
7980

80-
Supported expressions and function:
81+
Supported expressions and functions:
8182
```SQL
8283
+, -, *, /
8384
```
@@ -88,33 +89,34 @@ CASE WHEN <condition> THEN <result> [WHEN ...] ELSE <result> END
8889
SUM, AVG, MIN, MAX
8990
```
9091
```SQL
91-
(RANK | DENSE_RANK) OVER([PARTITION BY (<expresssion> [, <expression>...)])
92+
{RANK | DENSE_RANK} OVER([PARTITION BY (<expresssion> [, <expression>...)])
9293
```
9394
```SQL
9495
CAST <expression> AS <data_type>
9596
```
96-
*Anything in <> is meant to be some string
97-
*Anything in [] is optional
97+
*Anything in <> is meant to be some string <br>
98+
*Anything in [] is optional <br>
9899
*Anything in {} is grouped together
99100

100101
### Supported Data Types for cast expressions include:
101-
-VARCHAR, STRING
102-
-INT16, SMALLINT
103-
-INT32, INT
104-
-INT64, BIGINT
105-
-FLOAT16
106-
-FLOAT32
107-
-FLOAT, FLOAT64
108-
-BOOL
109-
-DATETIME64, TIMESTAMP
110-
-CATEGORY
111-
-OBJECT
102+
* VARCHAR, STRING
103+
* INT16, SMALLINT
104+
* INT32, INT
105+
* INT64, BIGINT
106+
* FLOAT16
107+
* FLOAT32
108+
* FLOAT, FLOAT64
109+
* BOOL
110+
* DATETIME64, TIMESTAMP
111+
* CATEGORY
112+
* OBJECT
112113

113114
*Data types in dataframe SQL support many different name for certain datatypes becuase
114-
popular SQL data types are not implemented with common names in pandas and other
115-
dataframe frameworks
116-
**To make this less confusing all data types that are of the same size on the
117-
backend are grouped together in this list
115+
popular SQL data types are not implemented with common names in pandas and other
116+
dataframe frameworks
117+
<br>
118+
**To make this less confusing all data types that are of the same size on the
119+
backend are grouped together in this list
118120

119121
## Issues that come from Pandas
120122

0 commit comments

Comments
 (0)