Merge pull request #2327 from kodebach/meta-doc-fix

Documentation fix for elektraMetaArrayToKS
ElektraInitiative · Jan 23, 2019 · 6dc8e61 · 6dc8e61
2 parents 8f15463 + d82da90
commit 6dc8e61
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/doc/news/_preparation_next_release.md b/doc/news/_preparation_next_release.md
@@ -208,7 +208,8 @@ you up to date with the multi-language support provided by Elektra.
 ## Documentation
 
 - We fixed various spelling mistakes. *(René Schwaiger)*
-- <<TODO>>
+- The documentation for `elektraMetaArrayToKS` was fixed. It now reflects the fact
+  that the parent key is returned as well.  *(Klemens Böswirth)*
 - <<TODO>>
 
 ## Tests

diff --git a/src/libs/meta/meta.c b/src/libs/meta/meta.c
@@ -951,7 +951,7 @@ elektraMetaArrayToKS(
 	"dep");
  * @endcode
  *
- * returns a `KeySet` containing the keys `"dep/#0"` with value `"/b"` and
+ * returns a `KeySet` containing the keys `dep` with value `#1`, `"dep/#0"` with value `"/b"` and
  * `"dep/#1"` with value `"/c"`.
  *
  * If no meta key array is found, null is returned.