Libelektra: update elektra-glossary.md

Created on 17 Nov 2019  路  5Comments  路  Source: ElektraInitiative/libelektra

Following is not explained in doc/help/elektra-glossary.md

  • [ ] key name
  • [ ] key base name
  • [ ] key name part

@kodebach can you do this within #3115 once it is settled?

documentation

Most helpful comment

See #3596. Note: I did not add "empty base name", because I don't think it's important enough to be included in the glossary. Without going into details about key name structure and escaped vs. unescaped name, empty key name parts also can really be explained.

In general I think, we should try to compact and slim down our documentation and not duplicate information. Elektra's documentation is already harder to navigate than some of the code base. Adding small pieces of information everywhere doesn't help users find what the are looking for.

All 5 comments

Will do

I mark this issue stale as it did not have any activity for one year. I'll close it in two weeks if no further activity occurs. If you want it to be alive again, ping the issue by writing a message here or create a new issue with the remainder of this issue.
Thank you for your contributions :sparkling_heart:

See #3596. Note: I did not add "empty base name", because I don't think it's important enough to be included in the glossary. Without going into details about key name structure and escaped vs. unescaped name, empty key name parts also can really be explained.

In general I think, we should try to compact and slim down our documentation and not duplicate information. Elektra's documentation is already harder to navigate than some of the code base. Adding small pieces of information everywhere doesn't help users find what the are looking for.

In general I think, we should try to compact and slim down our documentation and not duplicate information. Elektra's documentation is already harder to navigate than some of the code base. Adding small pieces of information everywhere doesn't help users find what the are looking for.

I agree that this is an important point.

Yes I agree, if we already have such pieces of information somewhere else (like in the key name docu) it is better to only refer to the place.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

markus2330 picture markus2330  路  49Comments

markus2330 picture markus2330  路  585Comments

markus2330 picture markus2330  路  27Comments

ingwinlu picture ingwinlu  路  36Comments

ingwinlu picture ingwinlu  路  35Comments