Skip to content

Commit 7d90824

Browse files
Francesca-Bitgithub-actions[bot]
authored andcommitted
Apply docs changes
1 parent c1d9550 commit 7d90824

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

docs/api/woql.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@ Every function matches one of the public api functions of the woql query object
1010

1111

1212
## using
13-
##### WOQL.using(refPath, subquery) ⇒ <code>WOQLQuery</code>
13+
##### WOQL.using(refPath, [subquery]) ⇒ <code>WOQLQuery</code>
1414
Query running against any specific commit Id
1515

1616

1717
| Param | Type | Description |
1818
| --- | --- | --- |
1919
| refPath | <code>string</code> | path to specific reference Id or commit Id |
20-
| subquery | <code>WOQLQuery</code> | subquery for the specific commit point |
20+
| [subquery] | <code>WOQLQuery</code> | subquery for the specific commit point |
2121

2222
**Example**
2323
```javascript
@@ -26,14 +26,14 @@ WOQL.using("userName/dbName/local/commit|branch/commitID").triple(a, b, c)
2626
```
2727

2828
## comment
29-
##### WOQL.comment(comment, subquery) ⇒ <code>WOQLQuery</code>
29+
##### WOQL.comment(comment, [subquery]) ⇒ <code>WOQLQuery</code>
3030
Adds a text comment to a query - can also be used to wrap any part of a query to turn it off
3131

3232

3333
| Param | Type | Description |
3434
| --- | --- | --- |
3535
| comment | <code>string</code> | text comment |
36-
| subquery | <code>WOQLQuery</code> | query that is "commented out" |
36+
| [subquery] | <code>WOQLQuery</code> | query that is "commented out" |
3737

3838

3939
## select
@@ -182,15 +182,15 @@ Specifies the database URL that will be the default database for the enclosed qu
182182

183183

184184
## into
185-
##### WOQL.into(graphRef-, subquery) ⇒ <code>WOQLQuery</code>
185+
##### WOQL.into(graphRef-, [subquery]) ⇒ <code>WOQLQuery</code>
186186
Specifies the graph resource to write the contained query into
187187

188188
**Returns**: <code>WOQLQuery</code> - A WOQLQuery which will be written into the graph in question
189189

190190
| Param | Type | Description |
191191
| --- | --- | --- |
192192
| graphRef- | <code>typedef.GraphRef</code> | A valid graph resource identifier string |
193-
| subquery | <code>WOQLQuery</code> | The query which will be written into the graph |
193+
| [subquery] | <code>WOQLQuery</code> | The query which will be written into the graph |
194194

195195
**Example**
196196
```javascript
@@ -1361,13 +1361,13 @@ literal(1, "nonNegativeInteger")
13611361

13621362
## date
13631363
##### WOQL.date(date) ⇒ <code>object</code>
1364-
Generates explicitly a JSON-LD string date literal from the input
1364+
Generates explicitly a JSON-LD literal date from the imput
13651365

1366-
**Returns**: <code>object</code> - - A JSON-LD literal
1366+
**Returns**: <code>object</code> - - A JSON-LD literal date
13671367

13681368
| Param | Type | Description |
13691369
| --- | --- | --- |
1370-
| date | <code>string</code> | any date string format YYYY-MM-DD |
1370+
| date | <code>string</code> | any date format string (YYYY-MM-DD) |
13711371

13721372
**Example**
13731373
```javascript
@@ -1376,14 +1376,14 @@ date("2022-10-02")
13761376
```
13771377

13781378
## datetime
1379-
##### WOQL.datetime(date) ⇒ <code>object</code>
1380-
Generates explicitly a JSON-LD string datetime literal from the input
1379+
##### WOQL.datetime(datetime) ⇒ <code>object</code>
1380+
Generates explicitly a JSON-LD literal datetime from the imput
13811381

1382-
**Returns**: <code>object</code> - - A JSON-LD literal
1382+
**Returns**: <code>object</code> - - A JSON-LD literal datetime
13831383

13841384
| Param | Type | Description |
13851385
| --- | --- | --- |
1386-
| date | <code>string</code> | any datetime string format YYYY-MM-DDThh-mm-ssZ |
1386+
| datetime | <code>string</code> | any datetime format string (YYYY-MM-DDThh-mm-ssZ) |
13871387

13881388
**Example**
13891389
```javascript
@@ -1393,9 +1393,9 @@ datetime("2022-10-19T14:17:12Z")
13931393

13941394
## boolean
13951395
##### WOQL.boolean(bool) ⇒ <code>object</code>
1396-
Generates explicitly a JSON-LD boolean literal from the input
1396+
Generates explicitly a JSON-LD literal boolean from the input
13971397

1398-
**Returns**: <code>object</code> - - A JSON-LD literal
1398+
**Returns**: <code>object</code> - - A JSON-LD literal boolean
13991399

14001400
| Param | Type | Description |
14011401
| --- | --- | --- |

0 commit comments

Comments
 (0)