Skip to content

Commit 7814851

Browse files
committed
Documentation update for experiment parameters = parameters
1 parent 5c560da commit 7814851

File tree

2 files changed

+34
-2
lines changed

2 files changed

+34
-2
lines changed

doc/CollectionQueries.md

+34-2
Original file line numberDiff line numberDiff line change
@@ -117,15 +117,47 @@ however in this case we have a little bit more expressiveness available, as we c
117117
![](./gif/collect4.gif)
118118

119119
```python
120-
"[smart] [<vertical_direction> [<ndir>] [function]] parameter <item_index> [<item_index2> [and <item_index3>]]"
120+
"[smart] [<vertical_direction> [<ndir>]] parameter <item_index> [<item_index2> [and <item_index3>]]"
121121

122122

123-
"[smart] [<vertical_direction> [<ndir>] [function]] (parameters all| parameter <item_index> until (<item_index2>| the end))"
123+
"[smart] [<vertical_direction> [<ndir>]] (parameters all| parameter <item_index> until (<item_index2>| the end))"
124124
```
125125

126126
notice that the syntax is very similar after the one used by big regions of interest queries `"<vertical_direction> [<ndir>] <block>"` for selecting things from other functions, but function is optional, so it can also be used in the more simple and traditional `"<vertical_direction> [<ndir>]"` this was chosen so most makes things easier to speak into either way we are extracting from function definitions:)
127127

128+
#### Experimental
128129

129130

131+
In the grammar bundles you are going to to see there are some extra commented lines
132+
133+
```python
134+
"[smart] [<vertical_direction> [<ndir>]] key parameter <item_index> [ and <item_index2> [and <item_index3>]]":
135+
lazy_value("collect_parameter",2,experimental = "True"),
136+
137+
"[smart] [<vertical_direction> [<ndir>]] key (parameters all| parameter <item_index> until (<item_index2>| the end))":
138+
lazy_value("collect_parameter",3,experimental = "True"),
139+
```
140+
141+
142+
143+
this is a little bit more functionality that that the backened has been adopted to support but I am still not sure if what it offers is worth the additional grammar complexity. furthermore they are still immature and may be subject to change. As a consequence, I chose not to include them in the "official" grammar but if you want you can enable them yourself by simply commending those lines.
144+
145+
Essentially they look just like the previous ones but in the spoken form there is a `key` word before the parameter( which of course you can change to what ever you wish) and an additional `experimental = "True"`, which is just a temporary way to inform the plug-in that we want experimental functionality.
146+
147+
where they defer is that instead of inserting
148+
149+
```python
150+
parameter1,parameter2,...
151+
```
152+
153+
they insert
154+
155+
```python
156+
parameter1=parameter1,parameter2=parameter2,...
157+
```
158+
159+
160+
![](./gif/collect7.gif)
161+
130162

131163

doc/gif/collect7.gif

106 KB
Loading

0 commit comments

Comments
 (0)