Merge pull request #44 from dbatten5/docs

docs update

Author: dbatten5

.github/workflows/tests.yml

@@ -1,8 +1,14 @@
 name: Tests
 
 on:
-  - push
-  - pull_request
+  push:
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
+  pull_request:
+    paths-ignore:
+      - "docs/**"
+      - "*.md"
 
 jobs:
   tests:

docs/usage.md

@@ -10,27 +10,22 @@ Suppose you want to convert a `numpy.NDArray` object to a LaTeX representation:
 
 ```python
 >>> import numpy as np
->>> A = np.arange(6).reshape(2, 3)
+>>> A = np.arange(1, 7).reshape(2, 3)
 >>> A
-array([[0, 1, 2],
-       [3, 4, 5]])
+array([[1, 2, 3],
+       [4, 5, 6]])
 ```
 
 ## To matrix
 
-First import the `to_matrix` function:
+Basic usage:
 
 ```python
 >>> from arraytex import to_matrix
-```
-
-Then run `to_matrix` with a `numpy.NDArray` object as the first argument:
-
-```python
 >>> print(to_matrix(A))
 \begin{bmatrix}
-0 & 1 & 2 \\
-3 & 4 & 5 \\
+1 & 2 & 3 \\
+4 & 5 & 6 \\
 \end{bmatrix}
 ```
 
@@ -39,15 +34,15 @@ Different matrix style environment delimiters can be used:
 ```python
 >>> print(to_matrix(A, style="p"))
 \begin{pmatrix}
-0 & 1 & 2 \\
-3 & 4 & 5 \\
+1 & 2 & 3 \\
+4 & 5 & 6 \\
 \end{pmatrix}
 ```
 
 So can builtin number formatters:
 
 ```python
->>> print(to_matrix((A + 1) * 1e3, num_format=".2e"))
+>>> print(to_matrix(A * 1e3, num_format=".2e"))
 \begin{bmatrix}
 1.00\mathrm{e}{+03} & 2.00\mathrm{e}{+03} & 3.00\mathrm{e}{+03} \\
 4.00\mathrm{e}{+03} & 5.00\mathrm{e}{+03} & 6.00\mathrm{e}{+03} \\
@@ -57,7 +52,7 @@ So can builtin number formatters:
 Prefer scientific notation to e-notation? No problem:
 
 ```python
->>> print(to_matrix((A + 1) * 1e3, num_format=".2e", scientific_notation=True))
+>>> print(to_matrix(A * 1e3, num_format=".2e", scientific_notation=True))
 \begin{bmatrix}
 1.00 \times 10^{+03} & 2.00 \times 10^{+03} & 3.00 \times 10^{+03} \\
 4.00 \times 10^{+03} & 5.00 \times 10^{+03} & 6.00 \times 10^{+03} \\
@@ -66,22 +61,17 @@ Prefer scientific notation to e-notation? No problem:
 
 ## To tabular
 
-First import the `to_tabular` function:
+Basic usage:
 
 ```python
 >>> from arraytex import to_tabular
-```
-
-Then run `to_tabular` with a `numpy.NDArray` as the first argument:
-
-```python
 >>> print(to_tabular(A))
 \begin{tabular}{c c c}
 \toprule
 Col 1 & Col 2 & Col 3 \\
 \midrule
-0 & 1 & 2 \\
-3 & 4 & 5 \\
+1 & 2 & 3 \\
+4 & 5 & 6 \\
 \bottomrule
 \end{tabular}
 ```
@@ -94,8 +84,8 @@ The `num_format` and `scientific_notation` arguments are available to use:
 \toprule
 Col 1 & Col 2 & Col 3 \\
 \midrule
-0.00 & 1.00 & 2.00 \\
-3.00 & 4.00 & 5.00 \\
+1.00 & 2.00 & 3.00 \\
+4.00 & 5.00 & 6.00 \\
 \bottomrule
 \end{tabular}
 ```
@@ -108,8 +98,8 @@ You can pass custom column names and column align identifiers:
 \toprule
 Data & More Data & Even More Data \\
 \midrule
-0 & 1 & 2 \\
-3 & 4 & 5 \\
+1 & 2 & 3 \\
+4 & 5 & 6 \\
 \bottomrule
 \end{tabular}
 ```
@@ -122,8 +112,8 @@ Pass a list of row identifiers to be used as a table index:
 \toprule
 Index & Col 1 & Col 2 & Col 3 \\
 \midrule
-Sample 1 & 0 & 1 & 2 \\
-Sample 2 & 3 & 4 & 5 \\
+Sample 1 & 1 & 2 & 3 \\
+Sample 2 & 4 & 5 & 6 \\
 \bottomrule
 \end{tabular}
 ```
@@ -136,8 +126,8 @@ Specify the name of the index column through `col_names`:
 \toprule
 Which Sample & A & B & C \\
 \midrule
-Sample 1 & 0 & 1 & 2 \\
-Sample 2 & 3 & 4 & 5 \\
+Sample 1 & 1 & 2 & 3 \\
+Sample 2 & 4 & 5 & 6 \\
 \bottomrule
 \end{tabular}
 ```