Skip to content

Commit 1f41c57

Browse files
authored
add a note about #8189 to the 0.77 release (#855)
* add a note about #8189 to the 0.77 release * move the last http comment back into its section
1 parent f2e26f7 commit 1f41c57

File tree

1 file changed

+54
-0
lines changed

1 file changed

+54
-0
lines changed

blog/2023-03-14-nushell_0_77.md

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -192,6 +192,60 @@ Signatures:
192192

193193
Make sure to browse the help messages of these commands. They contain fully functional examples thanks to pointing at www.example.com.
194194

195+
## Examples results are now shown in `help` pages ([amtoine](https://github.com/nushell/nushell/pull/8189))
196+
197+
When commands define expected results for their examples, the output is now shown just below the associated examples.
198+
199+
Let's take the `merge` command as an example!
200+
201+
Before the change, the output of `help merge` would give
202+
203+
```bash
204+
Examples:
205+
Add an 'index' column to the input table
206+
> [a b c] | wrap name | merge ( [1 2 3] | wrap index )
207+
208+
Merge two records
209+
> {a: 1, b: 2} | merge {c: 3}
210+
211+
Merge two tables, overwriting overlapping columns
212+
> [{columnA: A0 columnB: B0}] | merge [{columnA: 'A0*'}]
213+
```
214+
215+
Now, it gives the output of all the example commands:
216+
217+
```bash
218+
Examples:
219+
Add an 'index' column to the input table
220+
> [a b c] | wrap name | merge ( [1 2 3] | wrap index )
221+
╭───┬──────╮
222+
# │ name │
223+
├───┼──────┤
224+
│ 1 │ a │
225+
│ 2 │ b │
226+
│ 3 │ c │
227+
╰───┴──────╯
228+
229+
Merge two records
230+
> {a: 1, b: 2} | merge {c: 3}
231+
╭───┬───╮
232+
│ a │ 1 │
233+
│ b │ 2 │
234+
│ c │ 3 │
235+
╰───┴───╯
236+
237+
Merge two tables, overwriting overlapping columns
238+
> [{columnA: A0 columnB: B0}] | merge [{columnA: 'A0*'}]
239+
╭───┬─────────┬─────────╮
240+
# │ columnA │ columnB │
241+
├───┼─────────┼─────────┤
242+
│ 0 │ A0* │ B0 │
243+
╰───┴─────────┴─────────╯
244+
```
245+
246+
> :bulb: **Note**
247+
> the website has been modified accordingly with the same outputs.
248+
195249
# Breaking changes
196250

197251
- Alias changes, see above

0 commit comments

Comments
 (0)