docs: update format docs

Signed-off-by: Gabor Boros <[email protected]>

_jekyll/_data/api_java.yml

@@ -219,8 +219,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
-        - name: fmt
-          permalink: fmt
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_javascript.yml

@@ -219,8 +219,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
-        - name: fmt
-          permalink: fmt
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_python.yml

@@ -217,8 +217,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
-        - name: fmt
-          permalink: fmt
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

_jekyll/_data/api_ruby.yml

@@ -215,8 +215,8 @@
           permalink: upcase
         - name: downcase
           permalink: downcase
-        - name: fmt
-          permalink: fmt
+        - name: format
+          permalink: format
 - section:
     name: Math and logic
     commands:

api/java/index.md

@@ -1932,27 +1932,45 @@ Result:
 
 [Read more about this command →](split/)
 
-## [fmt](fmt/) ##
+## [format](format/) ##
 
 {% apibody %}
-r.fmt(string, object) → string
+r.format(string, object) → string
 {% endapibody %}
 
-Formats a template string based on a string-string key-value object.
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
 
-__Example:__
+__Example:__ Using simple parameters for formatting.
 
-```js
-r.fmt("{name} loves {candy}.", {"name": "Bob", "candy": "candy floss"}).run(conn, callback)
+```java
+r.format("{name} loves {candy}.",
+    r.hashMap("name", "Bob").with("candy", "candy floss")
+).run(conn, callback)
 ```
 
 Result:
 
-```js
+```java
 "Bob loves candy floss."
 ```
 
-[Read more about this command →](fmt/)
+__Example:__ Using row for formatting.
+
+```java
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```java
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```
+
+[Read more about this command →](format/)
 
 ## [upcase](upcase/) ##
 

api/java/string-manipulation/downcase.md

@@ -7,7 +7,7 @@ related_commands:
     upcase: upcase/
     match: match/
     split: split/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/format.md

@@ -0,0 +1,54 @@
+---
+layout: api-command
+language: Java
+permalink: api/java/format/
+command: format
+io:
+    -   - r
+        - string
+related_commands:
+    match: match/
+    split: split/
+    upcase: upcase/
+    downcase: downcase/
+---
+
+# Command syntax #
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+# Description #
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```java
+r.format("{name} loves {candy}.",
+    r.hashMap("name", "Bob").with("candy", "candy floss")
+).run(conn, callback)
+```
+
+Result:
+
+```java
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```java
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```java
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```

api/java/string-manipulation/match.md

@@ -10,7 +10,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     split: split/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/split.md

@@ -7,7 +7,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     match: match/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #

api/java/string-manipulation/upcase.md

@@ -7,7 +7,7 @@ related_commands:
     downcase: downcase/
     match: match/
     split: split/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/index.md

@@ -2009,18 +2009,21 @@ Result:
 
 [Read more about this command →](split/)
 
-## [fmt](fmt/) ##
+## [format](format/) ##
 
 {% apibody %}
-r.fmt(string, object) → string
+r.format(string, object) → string
 {% endapibody %}
 
-Formats a template string based on a string-string key-value object.
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
 
-__Example:__
+__Example:__ Using simple parameters for formatting.
 
 ```js
-r.fmt("{name} loves {candy}.", {"name": "Bob", "candy": "candy floss"}).run(conn, callback)
+r.format("{name} loves {candy}.", {
+    "name": "Bob",
+    "candy": "candy floss",
+}).run(conn, callback)
 ```
 
 Result:
@@ -2029,7 +2032,23 @@ Result:
 "Bob loves candy floss."
 ```
 
-[Read more about this command →](fmt/)
+__Example:__ Using row for formatting.
+
+```js
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```js
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```
+
+[Read more about this command →](format/)
 
 ## [upcase](upcase/) ##
 

api/javascript/string-manipulation/downcase.md

@@ -10,7 +10,7 @@ related_commands:
     upcase: upcase/
     match: match/
     split: split/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #

api/javascript/string-manipulation/format.md

@@ -0,0 +1,55 @@
+---
+layout: api-command
+language: JavaScript
+permalink: api/javascript/format/
+command: format
+io:
+    -   - r
+        - string
+related_commands:
+    match: match/
+    split: split/
+    upcase: upcase/
+    downcase: downcase/
+---
+
+# Command syntax #
+
+{% apibody %}
+r.format(string, object) → string
+{% endapibody %}
+
+# Description #
+
+Format command takes a string as a template and formatting parameters as an object. The parameters in the template string must exist as keys in the object, otherwise, an error raised. The template must be a string literal and cannot be the result of other commands.
+
+__Example:__ Using simple parameters for formatting.
+
+```js
+r.format("{name} loves {candy}.", {
+    "name": "Bob",
+    "candy": "candy floss",
+}).run(conn, callback)
+```
+
+Result:
+
+```js
+"Bob loves candy floss."
+```
+
+__Example:__ Using row for formatting.
+
+```js
+r.table("movies").map({
+  id: r.row('id'),
+  ratings: r.http(r.format('http://example.com/movies/?title={title}&release={year}', r.row))
+})
+```
+
+Result:
+
+```js
+// `ratings` is the result of the HTTP request
+[{ id: 1, ratings: { positive: 99, negative: 0 }}]
+```

api/javascript/string-manipulation/match.md

@@ -10,7 +10,7 @@ related_commands:
     upcase: upcase/
     downcase: downcase/
     split: split/
-    fmt: fmt/
+    format: format/
 ---
 
 # Command syntax #