Skip to content

Commit 7c7c68c

Browse files
committed
Improve docs
1 parent 16b3626 commit 7c7c68c

2 files changed

Lines changed: 3 additions & 3 deletions

File tree

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
* Deprecate `:links` option for `:unsafely_name_processes_for_observer` in favour of `:report_links_to_observer` configuration entry
88
* [Set label](https://hexdocs.pm/elixir/Process.html#set_label/1) for all the Membrane processes (i.e. for both Membrane components like pipelines, elements and bins and for utility components like subprocess supervisors)
99
* Update required Elixir version to `~> 1.17`
10-
* Add Mix tasks for easier initialization of components [#1059](https://github.com/membraneframework/membrane_core/pull/1059)
1110
* Add a Mix task for generating demos [#1067](https://github.com/membraneframework/membrane_core/pull/1067)
11+
* Add Mix tasks for easier initialization of components [#1059](https://github.com/membraneframework/membrane_core/pull/1059)
1212

1313
## 1.2.6
1414
* Add tutorials [#1007](https://github.com/membraneframework/membrane_core/pull/1007), plugins [#1012](https://github.com/membraneframework/membrane_core/pull/1012) and demos [#1013](https://github.com/membraneframework/membrane_core/pull/1013) to the docs.

lib/mix/tasks/membrane.demo.ex

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
defmodule Mix.Tasks.Membrane.Demo do
22
@shortdoc "Download Membrane demos and examples"
33
@moduledoc """
4-
Download Membrane demos and examples into the current directory. Requires `git` installed.
4+
Download Membrane demos and examples. Requires `git` installed.
55
66
$ mix membrane.demo [-a] [-l] [-d <repo_dir>] [<demos> ...]
77
88
## Options
99
* `-l, --list` - List all demos available and their brief descriptions.
1010
* `-a, --all` - Pull the repository with all demos.
11-
* `-d, --directory` - Specify a directory where the demos should be placed in.
11+
* `-d, --directory` - Specify a directory where the demos should be placed in. By default they're placed in the current working directory
1212
"""
1313
use Mix.Task
1414

0 commit comments

Comments
 (0)