Skip to content
This repository has been archived by the owner on Oct 15, 2024. It is now read-only.

doc: Improve readability of section in High-Level API tutorial #3717

Merged
merged 7 commits into from
Mar 25, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/news/_preparation_next_release.md
Original file line number Diff line number Diff line change
Expand Up @@ -214,6 +214,7 @@ _(@tucek)_
- Added a short Visual Studio 2019 tutorial (/doc/tutorials/contributing-windows.md) _(Dominic Jäger)_
- Added hint regarding WSL filesystem configuration (/doc/tutorials/contributing-windows.md) _(@tucek)_
- Fixed broken link in yanlr-plugin readme _(@lawli3t)_
- Minor readability improvement in [highlevel.md](/doc/tutorials/highlevel.md) _(Tobias Schubert @qwepoizt)_

## Tests

Expand Down
7 changes: 5 additions & 2 deletions doc/tutorials/highlevel.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ type = float
default = 1.1
```

In Elektra a specification is defined through the metadata of keys in the `spec` namespace. The specification above contains metadata for
three keys the parent key (`@`), `@/mydouble` and `@/myfloatarray/#`. The `#` at the end of `myfloatarray/#` indicates that it is an array.
In Elektra a specification is defined through the metadata of keys in the `spec` namespace. The specification above contains metadata for three keys:

1. the parent key (`@`)
2. `@/mydouble`
3. `@/myfloatarray/#` (The `#` at the end of `myfloatarray/#` indicates that it is an array)

The `mountpoint` metadata on the parent key sets the name of our application's config file (the location is defined by Elektra), it should
be unique.
Expand Down