Notes updates

JavaScriptDude · May 2, 2022 · 5aa62af · 5aa62af
1 parent ada3c7f
commit 5aa62af
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-## `multisort` - NoneType Safe Multi Column Sorting
+## `multisort` - NoneType Safe Multi Column Sorting For Python
 
 Simplified multi-column sorting of lists of tuples, dicts, lists or objects that are NoneType safe.
 
@@ -69,6 +69,21 @@ rows_sorted = msorted(rows_dict, [
 ])
 
 ```
+`msorted` parameters:
+option|dtype|description
+---|---|---
+`key`|int or str|Key to access data. int for tuple or list
+`spec`|str, int, list|Sort specification. Can be as simple as a column key / index
+`reverse`|bool|Reverse order of final sort (defalt = False)
+
+`msorted` `spec` options:
+option|dtype|description
+---|---|---
+reverse|bool|Reverse sort of column
+clean|func|Function / lambda to clean the value
+none_first|bool|If True, None will be at top of sort. Default is False (bottom)
+
+
 
 ### `sorted` with `reversor`
 Sort rows_dict by _grade_, descending, then _attend_ and call upper() for _grade_:

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "multisort"
-version = "0.1.0"
+version = "0.1.1"
 description = "NoneType Safe Multi Column Sorting For Python"
 license = "MIT"
 authors = ["Timothy C. Quinn"]