From 423ddbd6d172081964e2daf1860706925301da86 Mon Sep 17 00:00:00 2001
From: "Alex A. Naanou" <alex.nanou@gmail.com>
Date: Sat, 3 Apr 2021 02:11:02 +0300
Subject: [PATCH] docs...

Signed-off-by: Alex A. Naanou <alex.nanou@gmail.com>
---
 README.md | 119 +++++++++++++++++++++++++++++++++++++++++++++++-------
 Set.js    |  12 +++---
 2 files changed, 110 insertions(+), 21 deletions(-)

diff --git a/README.md b/README.md
index 891a64c..77d50ab 100644
--- a/README.md
+++ b/README.md
@@ -404,6 +404,8 @@ Object.keys(Object.sort(o, ['x', 'a', '100']))
 //    -> [ '0', '100', 'x', 'a', ' 27 ', 'b' ]
 ```
 
+This is similar to [`<map>.sort(..)`](#mapsort) and [`<ser>.sort(..)`](#setsort).
+
 
 ## `Array`
 
@@ -836,14 +838,29 @@ but before the timeout.
 require('ig-types/Map')
 ```
 
-<!-- XXX -->
-
 
 ### `<map>.sort(..)`
 
-<!-- XXX -->
+Sort `<map>` keys in-place
+```bnf
+<map>.sort()
+    -> <map>
 
+<map>.sort(<cmp>)
+    -> <map>
+```
 
+In the general case this is similar to 
+[`<array>.sort(..)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 
+with the addition of the [`<array>.sortAs(..)`](#arraysortas)'s ability to sort 
+as a list
+```bnf
+<map>.sort(<sorted-keys>)
+    -> <map>
+```
+
+This is similar to [`<set>.sort(..)`](#setsort) and [`Object.sort(..)`](#objectsort), 
+see the later for more info.
 
 
 ## `Set`
@@ -852,9 +869,6 @@ require('ig-types/Map')
 require('ig-types/Set')
 ```
 
-<!-- XXX -->
-
-
 
 ### `<set>.unite(..)`
 
@@ -873,8 +887,27 @@ require('ig-types/Set')
 
 ### `<set>.sort(..)`
 
-<!-- XXX -->
+Sort `<set>` keys in-place
+```bnf
+<set>.sort()
+    -> <set>
 
+<set>.sort(<cmp>)
+    -> <set>
+```
+
+In the general case this is similar to 
+[`<array>.sort(..)`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort) 
+with the addition of the [`<array>.sortAs(..)`](#arraysortas)'s ability to sort 
+as a list
+```bnf
+<set>.sort(<sorted-values>)
+    -> <set>
+```
+
+
+This is similar to [`<map>.sort(..)`](#mapsort) and [`Object.sort(..)`](#objectsort),
+see the later for more info.
 
 
 ## `Date`
@@ -883,17 +916,36 @@ require('ig-types/Set')
 require('ig-types/Date')
 ```
 
-<!-- XXX -->
-
 
 ### `Date.timeStamp(..)`
 
-<!-- XXX -->
+Generate a timestamp (format: `'YYYYMMDDHHMMSS'`)
+```bnf
+Date.timeStamp()
+    -> <timestamp>
+```
+
+Generate a full timestamp, including milliseconds (format: `'YYYYMMDDHHMMSSmmm'`)
+```bnf
+Date.timeStamp(true)
+    -> <timestamp>
+```
+
+This is a shorthand to: [`(new Date()).getTimeStamp(..)`](#dategettimestamp)
+
+The timestamp is generated from the time of call, for generating timestamps form specific `<date>` objects see:
+[`<date>.getTimeStamp(..)`](#dategettimestamp)
 
 
 ### `Date.fromTimeStamp(..)`
 
-<!-- XXX -->
+Create a `<date>` from a timestamp
+```bnf
+Date.fromTimeStamp(<timestamp>)
+    -> <date>
+```
+
+This is a shorthand to: [`(new Date()).setTimeStamp(<timestamp>)`](#datesettimestamp)
 
 
 ### `Date.str2ms(..)`
@@ -966,18 +1018,55 @@ Supported formats:
 
 ### `<date>.toShortDate(..)`
 
-<!-- XXX -->
+Generate a short date string from `<date>` 
+(format: `'YYYY-MM-DD HH:MM:SS'`)
+```bnf
+<date>.toShortDate()
+    -> <short-date>
+```
+
+Generate a short date string including milliseconds from `<date>` 
+(format: `'YYYY-MM-DD HH:MM:SS:mmm'`)
+```bnf
+<date>.toShortDate(true)
+    -> <short-date>
+```
+
+Note that `<short-date>` is directly parseable by `new Date(..)`
+```javascript
+var a = (new Date()).toShortDate(true)
+
+// parse the <short-date> and generate a new short date from it...
+var b = (new Date(a)).toShortDate(true)
+
+a == b // -> true
+```
 
 
 ### `<date>.getTimeStamp(..)`
 
-<!-- XXX -->
+Generate a timestamp from `<date>`
+(format `'YYYYMMDDHHMMSS'`)
+```bnf
+<date>.getTimeStamp()
+    -> <timestamp>
+```
+
+Generate a timestamp from `<date>` including milliseconds 
+(format `'YYYYMMDDHHMMSSmmm'`)
+```bnf
+<date>.getTimeStamp(true)
+    -> <timestamp>
+```
 
 
 ### `<date>.setTimeStamp(..)`
 
-<!-- XXX -->
-
+Update a `<date>` from a timestamp
+```bnf
+<date>.setTimeStamp(<timestamp>)
+    -> <date>
+```
 
 
 ## `String`
diff --git a/Set.js b/Set.js
index 845c738..7b27545 100644
--- a/Set.js
+++ b/Set.js
@@ -32,14 +32,14 @@ object.Mixin('SetMixin', 'soft', {
 			.filter(function(e){ 
 				return !other.has(e) })) },
 
-	sort: function(keys=[]){
-		keys = (typeof(keys) == 'function' 
-				|| keys === undefined) ?
-			[...this].sort(keys)
-			: keys
+	sort: function(values=[]){
+		values = (typeof(values) == 'function' 
+				|| values === undefined) ?
+			[...this].sort(values)
+			: values
 		var del = this.delete.bind(this)
 		var add = this.add.bind(this)
-		new Set([...keys, ...this])
+		new Set([...values, ...this])
 			.forEach(function(e){
 				if(this.has(e)){
 					del(e)