Update actiondoc and contributing docs [skip ci]

See skytable/docs#20 and skytable/docs#19 for more info.

CONTRIBUTING.md

@@ -55,6 +55,18 @@ to next if they don't change things significantly; for example, changes in docum
 however the changes are huge, then they must be created on a separate branch, a pull request opened, the CI suite run and
 finally merged into next.
 
+## Pull request guidelines
+
+### Typo correction or doc updates
+
+The creation of superflous merge requests is generally discouraged. Such examples include the creation of multiple
+PRs to correct single typos, update comments or update docs.
+
+It would be far better if you could fix a considerable subset (if not all) of these issues in one pull request (it's fine to create multiple commits in the same PR).
+This is because we don't want to utilize compute capacity or multiply our git history for changes
+that do not have any behavioral impact. It is recommended that you open up a single PR and correct a substantial subset of these inconsistencies (if not all), while also adding `[skip ci]` or `[ci skip]` in your
+commit messages to avoid triggering the workflows.
+
 ## Steps
 
 1. Fork the repository
@@ -92,4 +104,4 @@ Testing is simple: just run this:
 make test
 ```
 
-> **NOTE**: Make sure port 2003 is not used by any applications and make sure your own instance isn't running on port 2003! The test suite creates a `testsuite` keyspace and some tables within it to run all the tests.
+> **NOTE**: Make sure port 2003 and 2004 are not used by any applications. Also, make sure your _own instance_ isn't running on any of these ports; if that is the case, you might end up losing data due to conflicting entity names! The test suite creates a `testsuite` keyspace and some tables within it to run all the tests.

README.md

@@ -68,7 +68,7 @@ This project strictly follows semver, however, since this project is currently i
 
 [![Contribute Now](https://img.shields.io/badge/%F0%9F%8C%9Fcontribute-now-a94064?style=for-the-badge)](https://ohsayan.github.io/skythanks)
 
-**Yes - we need you!** Be it a typo, a bizarre idea, a dirty bug🐞 or an amazing patch - you're welcome to contribute to Skytable! Beginner friendly issues are marked with the [<img src=https://img.shields.io/badge/L--easy-C71585>](https://github.com/skytable/skytable/labels/L-easy) label. Read the guide [here](./CONTRIBUTING.md).
+You are welcome to contribute to Skytable! Beginner friendly issues are marked with the [<img src=https://img.shields.io/badge/L--easy-C71585>](https://github.com/skytable/skytable/labels/L-easy) label. Read the guide [here](./CONTRIBUTING.md).
 
 ## Contributors
 

actiondoc.yml

@@ -36,25 +36,27 @@
   complexity: O(1)
   accept: [AnyArray]
   syntax: [GET <key>]
-  desc: Get the value of a key from the current table
+  desc: Get the value of a key from the current table, if it exists
   return: [Rcode 1, String, Binstr]
 - name: MGET
   complexity: O(n)
   accept: [AnyArray]
   syntax: [MGET <key1> <key2> ...]
-  desc: Get the value of 'n' keys from the current table
+  desc: Get the value of 'n' keys from the current table, if they exist
   return: [Typed Array]
 - name: SET
   complexity: O(1)
   accept: [AnyArray]
   syntax: [SET <key> <value>]
-  desc: Set the value of a key in the current table
+  desc: Set the value of a key in the current table, if it doesn't already exist
   return: [Rcode 0, Rcode 2, Rcode 5]
 - name: MSET
   complexity: O(n)
   accept: [AnyArray]
   syntax: [MSET <key1> <value1> <key2> <value2> ...]
-  desc: Set the value of 'n' keys in the current table
+  desc: |
+    Set the value of 'n' keys in the current table, if they don't already exist. This will
+    return the number of keys that were set as an unsigned integer.
   return: [Integer, Rcode 5]
 - name: UPDATE
   complexity: O(1)
@@ -66,19 +68,25 @@
   complexity: O(n)
   accept: [AnyArray]
   syntax: [MUPDATE <key1> <value1> <key2> <value2> ...]
-  desc: Update the value of 'n' keys in the current table
+  desc: |
+    Update the value of 'n' keys in the current table, if they already exist. This will return
+    the number of keys that were updated as an unsigned integer.
   return: [Integer, Rcode 5]
 - name: DEL
   complexity: O(n)
   accept: [AnyArray]
   syntax: [DEL <key1> <key2> ...]
-  desc: Delete 'n' keys from the current table
+  desc: |
+    Delete 'n' keys from the current table. This will return the number of keys that were deleted
+    as an unsigned integer
   return: [Integer, Rcode 5]
 - name: EXISTS
   complexity: O(n)
   accept: [AnyArray]
   syntax: [EXISTS <key1> <key2> ...]
-  desc: Check if 'n' keys exist in the current table
+  desc: |
+    Check if 'n' keys exist in the current table. This will return the number of keys that exist
+    as an unsigned integer.
   return: [Integer]
 - name: SSET
   complexity: O(n)
@@ -129,13 +137,13 @@
 - name: MKSNAP
   complexity: O(n)
   accept: [AnyArray]
-  syntax: [MKSNAP <SNAPNAME>]
+  syntax: [MKSNAP, MKSNAP <SNAPNAME>]
   desc: |
     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 <SNAPNAME> to specify a snapshot name and a snapshot will
-    be create in a folder called `remote` under your snapshots directory. For more
+    pass a second argument `<SNAPNAME>` to specify a snapshot name and a snapshot will
+    be create in a folder called `rsnap` under your data directory. For more
     information on snapshots, read [this document](/snapshots)
   return: [Rcode 0, err-snapshot-disabled, err-snapshot-busy]
 - name: LSKEYS
@@ -144,31 +152,29 @@
   syntax: [LSKEYS <limit>, LSKEYS <entity>, LSKEYS <entity> <limit>]
   desc: |
     Returns a flat string array of keys present in the current table or in the provided entity.
-    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. The order of keys is meaningless.
+    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. The order of keys is meaningless.
   return: [Typed Array]
 - name: POP
   complexity: O(1)
   accept: [AnyArray]
   syntax: [POP <key>]
-  desc: Deletes and return the value of the provided key from the current table.
+  desc: |
+    Deletes and return the value of the provided key from the current table.
+    If the database is poisoned, this will return a server error.
   return: [String, Binstr, Rcode 5]
 - name: MPOP
   complexity: O(n)
   accept: [AnyArray]
-  syntax: [POP <key1> <key2> ...]
+  syntax: [MPOP <key1> <key2> ...]
   desc: |
     Deletes and returns the values of the provided 'n' keys from the current table.
-    If the database is poisoned, this will return a server error. An exceptional scenario
-    can arise when the database fails in-between removing all the keys. In that case, you
-    get the server error response code instead of the keys. If the server recovers inbetween,
-    then the appropriate values (if any) will be returned. In all other cases a NIL error is
-    returned (code 1)
-  return: [Typed Array]
+    If the database is poisoned, this will return a server error
+  return: [Typed Array, Rcode 5]
 - name: HEYA
   complexity: O(1)
   accept: [AnyArray]
   syntax: [HEYA, HEYA <message>]
   desc: |
-    Either returns a "HEY!" or returns the provided argument as a String
+    Either returns a "HEY!" or returns the provided argument as an `str`
   return: [String]