Fix actiondoc parsing

ohsayan · ohsayan · commit 176cb07ebf99 · 2021-05-27T20:01:23.000+05:30
diff --git a/docbuilder/Cargo.toml b/docbuilder/Cargo.toml
@@ -7,4 +7,4 @@ edition = "2018"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-serde-hjson = {version= "0.9.1", default-features = false}
+serde-hjson = {version= "0.9.1", default-features = false}
diff --git a/docbuilder/src/main.rs b/docbuilder/src/main.rs
@@ -44,33 +44,47 @@ fn main() {
         .arg("actions.jsonc")
         .output()
         .unwrap();
-    let json: Value =
-        serde_hjson::from_str(&output).unwrap();
+    let json: Value = serde_hjson::from_str(&output).unwrap();
     let json = json.as_array().unwrap();
     let mut actions = Vec::new();
     for val in json {
         let obj = val.as_object().unwrap();
         let name = obj.get("name").unwrap().to_string();
         let id = name.to_lowercase();
-        let since = obj.get("since").unwrap();
         let complexity = obj.get("complexity").unwrap();
         let args = obj.get("args").unwrap();
         let returns = obj.get("return").unwrap();
         let desc = obj.get("desc").unwrap().to_string();
         let desc = desc.replace("<br>", "  \n");
         // Now we have all the details; time to construct the page
         let mut actionpage = String::new();
+        // add the page meta ---
         actionpage.push_str("---\n");
+        // add the document id
         actionpage.push_str(&format!("id: {}\n", id));
+        // add the title
         actionpage.push_str(&format!("title: {}\n", name));
+        // add the page meta end ---
         actionpage.push_str("---\n");
+        // add the note admonition
         actionpage.push_str(":::note About\n");
-        actionpage.push_str(&format!("**Since**: {}  \n", since));
+        // add the time complexity
         actionpage.push_str(&format!("**Time complexity**: {}  \n", complexity));
+        // add the arguments
         actionpage.push_str(&format!("**Arguments**: `{}`  \n", args));
+        // add the returns
         actionpage.push_str(&format!("**Returns**: {}  \n", returns));
+        // add the end of the admonition
         actionpage.push_str(":::\n");
-        actionpage.push_str(&desc);
+        // add the description
+        actionpage.push_str(
+            &desc
+                .trim()
+                .replace("<", "&lt;")
+                .replace(">", "&gt;")
+                .replace("'''", ""),
+        );
+        // now push the action into the collection of actions
         actions.push(Document(name, actionpage));
     }
     actions.sort();
@@ -82,8 +96,8 @@ fn create_docs(list: Vec<Document>) {
     filetop.push_str("Actions are like shell commands: they take arguments and do something! Skytable currently supports the following actions: \n\n");
     for action in list {
         let name = action.0;
-        filetop.push_str(&format!("* [{}](actions/{}.md)\n", &name, &name));
-        let mut file = std::fs::File::create(format!("../docs/actions/{}.md", name)).unwrap();
+        filetop.push_str(&&format!("* [{}](actions/{}.md)\n", &name, &name));
+        let mut file = std::fs::File::create(&format!("../docs/actions/{}.md", name)).unwrap();
         file.write_all(&action.1.into_bytes()).unwrap();
     }
     let mut file = std::fs::File::create("../docs/actions.md").unwrap();
diff --git a/docs/2.getting-started.md b/docs/2.getting-started.md
@@ -8,7 +8,7 @@ Getting started with Skytable is easy 😊 (and fun!). You can get started with
 
 ### Step 1: Download a bundle
 
-Head over to this [page](https://github.com/skytable/skytable/releases/v0.5.2) and download a version for your platform.
+Head over to this [page](https://github.com/skytable/skytable/releases/v0.5.3) and download a version for your platform.
 
 ### Step 2: Make the files runnable
 
@@ -34,7 +34,7 @@ First of all, you need to have Docker installed and available on your `PATH` ; y
 Open up a terminal and run:
 
 ``` 
-docker create skytable/sdb:v0.5.2 --name skyvm
+docker create skytable/sdb:v0.5.3 --name skyvm
 ```
 
 :::note
diff --git a/docs/3.building-from-source.md b/docs/3.building-from-source.md
@@ -15,12 +15,12 @@ Besides, the TLS/SSL components are written in C (OpenSSL) &mdash; so you'll nee
 ### Step 2: Clone the tag
 Run this from your terminal:
 ```
-git clone --branch v0.5.2 https://github.com/skytable/skytable.git
+git clone --branch v0.5.3 https://github.com/skytable/skytable.git
 ```
 :::tip Bonus tip
 If you want to avoid downloading all the version history, run this instead:
 ```
-git clone --depth 1 --branch v0.5.2 https://github.com/skytable/skytable.git
+git clone --depth 1 --branch v0.5.3 https://github.com/skytable/skytable.git
 ```
 :::
 ### Step 3: Build it!
diff --git a/docs/5.benchmarking.md b/docs/5.benchmarking.md
@@ -6,7 +6,7 @@ Who doesn't like speed and as a consequence, benchmarks? So here's a guide on be
 
 ## Step 0: Getting the benchmarking tool
 
-You'll need to download a bundle from the [releases page](https://github.com/skytable/skytable/releases/v0.5.2) and unzip it. In the following steps we'll assume that you have unzipped the archive and you're in that directory.
+You'll need to download a bundle from the [releases page](https://github.com/skytable/skytable/releases/v0.5.3) and unzip it. In the following steps we'll assume that you have unzipped the archive and you're in that directory.
 
 ## Step 1: Starting the database server
 
diff --git a/docs/actions/DBSIZE.md b/docs/actions/DBSIZE.md
@@ -3,7 +3,6 @@ id: dbsize
 title: DBSIZE
 ---
 :::note About
-**Since**: 0.4.3  
 **Time complexity**: O(1)  
 **Arguments**: `DBSIZE`  
 **Returns**: Number of keys that exist in the database as an unsigned int  
diff --git a/docs/actions/DEL.md b/docs/actions/DEL.md
@@ -3,7 +3,6 @@ id: del
 title: DEL
 ---
 :::note About
-**Since**: 0.1.0  
 **Time complexity**: O(n)  
 **Arguments**: `DEL <key1> <key2> ...`  
 **Returns**: Number of keys that were deleted as an unsigned int  
diff --git a/docs/actions/EXISTS.md b/docs/actions/EXISTS.md
@@ -3,7 +3,6 @@ id: exists
 title: EXISTS
 ---
 :::note About
-**Since**: 0.4.0  
 **Time complexity**: O(n)  
 **Arguments**: `EXISTS <key1> <key2> ...`  
 **Returns**: Number of keys that exist as an unsigned int  
diff --git a/docs/actions/FLUSHDB.md b/docs/actions/FLUSHDB.md
@@ -3,7 +3,6 @@ id: flushdb
 title: FLUSHDB
 ---
 :::note About
-**Since**: 0.4.3  
 **Time complexity**: O(n)  
 **Arguments**: `FLUSHDB`  
 **Returns**: (Code: 0) if the operation succeeded  
diff --git a/docs/actions/GET.md b/docs/actions/GET.md
@@ -3,7 +3,6 @@ id: get
 title: GET
 ---
 :::note About
-**Since**: 0.1.0  
 **Time complexity**: O(1)  
 **Arguments**: `GET <key>`  
 **Returns**: Value if it exists or (Code: 1) if it does not  
diff --git a/docs/actions/KEYLEN.md b/docs/actions/KEYLEN.md
@@ -3,7 +3,6 @@ id: keylen
 title: KEYLEN
 ---
 :::note About
-**Since**: 0.4.4  
 **Time complexity**: O(1)  
 **Arguments**: `KEYLEN <key>`  
 **Returns**: Length of the key as an unsigned int  
diff --git a/docs/actions/LSKEYS.md b/docs/actions/LSKEYS.md
@@ -3,9 +3,8 @@ id: lskeys
 title: LSKEYS
 ---
 :::note About
-**Since**: 0.6.0  
 **Time complexity**: O(n)  
-**Arguments**: `LSKEYS <<limit>>`  
+**Arguments**: `LSKEYS <limit>`  
 **Returns**: Returns a maximum of 10 keys if no limit is specified or returns a maximum number of keys for the given limit  
 :::
-Returns a flat string array of keys present in the database. If no <<limit>> is given, then a maximum of 10 keys are returned. If a limit is specified, then a maximum of <<limit>> keys are returned
+Returns a flat string array of keys present in the database. If no &lt;limit&gt; is given, then a maximum of 10 keys are returned. If a limit is specified, then a maximum of &lt;limit&gt; keys are returned
diff --git a/docs/actions/MGET.md b/docs/actions/MGET.md
@@ -3,7 +3,6 @@ id: mget
 title: MGET
 ---
 :::note About
-**Since**: 0.4.0  
 **Time complexity**: O(n)  
 **Arguments**: `MGET <key1> <key2> ...`  
 **Returns**: Value if it exists or (Code: 1) if it does not  
diff --git a/docs/actions/MKSNAP.md b/docs/actions/MKSNAP.md
@@ -3,14 +3,12 @@ id: mksnap
 title: MKSNAP
 ---
 :::note About
-**Since**: 0.5.0  
 **Time complexity**: O(n)  
 **Arguments**: `MKSNAP <SNAPNAME>`  
 **Returns**: Okay if succeeded, otherwise it returns `err-snapshot-disabled` if snapshotting is disabled or `err-snapshot-busy` if a snapshotting operation is already in progress  
 :::
 
-  '''
-  This action can be used to create a snapshot. Do note that this action **requires snapshotting to be enabled on the server side**, before it can create snapshots.  
-  If you want to create snapshots **without** snapshots being enabled on the server-side, use a second argument (`[SNAPNAME]`) to specify a snapshot name and a snapshot will be create in a folder called `remote` under your snapshots directory.  
+  This action can be used to create a snapshot. Do note that this action **requires snapshotting to be enabled on the server side**, before it can create snapshots. 
+  If you want to create snapshots **without** snapshots being enabled on the server-side, pass a second argument &lt;SNAPNAME&gt; to specify a snapshot name and a snapshot will be create in a folder called `remote` under your snapshots directory. 
   For more information on snapshots, read [this document](/snapshots)
-  '''
+  
diff --git a/docs/actions/MSET.md b/docs/actions/MSET.md
@@ -3,7 +3,6 @@ id: mset
 title: MSET
 ---
 :::note About
-**Since**: 0.4.0  
 **Time complexity**: O(n)  
 **Arguments**: `MSET <key1> <value1> <key2> <value2> ...`  
 **Returns**: Number of keys that were set as an unsigned int  
diff --git a/docs/actions/MUPDATE.md b/docs/actions/MUPDATE.md
@@ -3,7 +3,6 @@ id: mupdate
 title: MUPDATE
 ---
 :::note About
-**Since**: 0.4.0  
 **Time complexity**: O(n)  
 **Arguments**: `MUPDATE <key1> <value1> <key2> <value2> ...`  
 **Returns**: Number of keys that were updated as an unsigned int  
diff --git a/docs/actions/SDEL.md b/docs/actions/SDEL.md
@@ -3,7 +3,6 @@ id: sdel
 title: SDEL
 ---
 :::note About
-**Since**: 0.4.3  
 **Time complexity**: O(n)  
 **Arguments**: `SDEL <key1> <key2> ...`  
 **Returns**: (Code: 0) if all keys were deleted, otherwise (Code: 1)  
diff --git a/docs/actions/SET.md b/docs/actions/SET.md
@@ -3,7 +3,6 @@ id: set
 title: SET
 ---
 :::note About
-**Since**: 0.1.0  
 **Time complexity**: O(1)  
 **Arguments**: `SET <key> <value>`  
 **Returns**: (Code: 0) if succeeded or (Code: 2) if not  
diff --git a/docs/actions/SSET.md b/docs/actions/SSET.md
@@ -3,7 +3,6 @@ id: sset
 title: SSET
 ---
 :::note About
-**Since**: 0.4.3  
 **Time complexity**: O(n)  
 **Arguments**: `SSET <key1> <value1> <key2> <value2> ...`  
 **Returns**: (Code: 0) if all keys were set, otherwise (Code: 2)  
diff --git a/docs/actions/SUPDATE.md b/docs/actions/SUPDATE.md
@@ -3,7 +3,6 @@ id: supdate
 title: SUPDATE
 ---
 :::note About
-**Since**: 0.4.3  
 **Time complexity**: O(n)  
 **Arguments**: `SUPDATE <key1> <value1> <key2> <value2> ...`  
 **Returns**: (Code: 0) if all keys were updated, otherwise (Code: 1)  
diff --git a/docs/actions/UPDATE.md b/docs/actions/UPDATE.md
@@ -3,7 +3,6 @@ id: update
 title: UPDATE
 ---
 :::note About
-**Since**: 0.1.0  
 **Time complexity**: O(1)  
 **Arguments**: `UPDATE <key> <value>`  
 **Returns**: (Code: 0) if succeeded or (Code: 1) if not  
diff --git a/docs/actions/USET.md b/docs/actions/USET.md
@@ -3,7 +3,6 @@ id: uset
 title: USET
 ---
 :::note About
-**Since**: 0.4.4  
 **Time complexity**: O(n)  
 **Arguments**: `USET <key1> <value1> <key2> <value2> ...`  
 **Returns**: Number of keys that were `USET`ed, as an unsigned int  
