doc: Improve readability of section in High-Level API tutorial #3717
Conversation
doc/tutorials/highlevel.md
Outdated
| @@ -37,7 +37,7 @@ 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. | |||
| three keys: 1. the parent key (`@`), 2. `@/mydouble` and 3. `@/myfloatarray/#`. The `#` at the end of `myfloatarray/#` indicates that it is an array. | |||
There was a problem hiding this comment.
Maybe you can even make a proper markdown enumeration?
Please do not forget to add release notes and to make the build server happy.
There was a problem hiding this comment.
Thanks for the suggestion, I converted it into an enum and added release notes!
|
Thank you very much for creating the PR!
Adding something to the release notes always applies because every contribution needs to be honored properly. |
|
@markus2330 1 check failed because Cirrus CI reports a broken link (http://www.complang.tuwien.ac.at/raab/akademy.pdf) in doc/news/2018-08-18_0.8.24.md. Without The broken link seems to be unrelated to my changes, I'm not sure how to proceed? |
|
Since there is now a merge conflict, you should rebase the PR branch onto master. You can ignore the broken link. We can merge the PR, if everything else works. Maybe we can fix the link (it is a tuwien.ac.at link after all), but if not we can also add the link to the whitelist. |
|
I suggest ignoring the broken link for now. As announced in #160 our build infrastructure is down. The broken link is affected by the same planned outage which should be resolved today. I would advise against merging during this period. The merge conflict will need to be resolved by rebasing on current master as @kodebach already said. Otherwise it looks good to me. 👍 |
|
Yes, please add www, this was a recent change in the complang infrastructure. complang.tuwien.ac.at does not redirect to www.complang.tuwien.ac.at anymore. |
|
Thank you all for the input, I will attend to it in the coming days. |
|
I rebased my branch patch-1 from upstream master and all checks have passed. Please, feel free to merge this PR! |
|
Thank you so much for the docu improvements! (The last build error is a known sporadic error #3679) |
This is just a minor change to improve readability. After having read through all items of the PR guidelines, I believe none of them applies.