libelektra icon indicating copy to clipboard operation
libelektra copied to clipboard

[CM T0] update array tutorial

Open markus2330 opened this issue 3 years ago • 7 comments

for natural sorting (_ are not needed anymore)

https://www.libelektra.org/tutorials/arrays

see also #4249

markus2330 avatar Feb 23 '22 07:02 markus2330

Probably best if we check all tutorials/docs and mark everything outdated with e.g. [Deprecated] in the title (since I doubt we have time to update everything).

kodebach avatar Feb 23 '22 08:02 kodebach

For 1.0 we should either update or remove. Before 1.0 it is enough to have issues that say that something is outdated/missing.

markus2330 avatar Mar 05 '22 10:03 markus2330

For 1.0 we should either update or remove.

Of course, but...

Before 1.0 it is enough to have issues that say that something is outdated/missing.

... since people are still using Elektra before 1.0, we should probably mark outdated stuff inside the docs themselves and not hope they see the related issue.

kodebach avatar Mar 05 '22 10:03 kodebach

Ok, then let us add TODO marker? [Deprecated] sounds like that the thing the tutorial is about (like arrays) is out-of-date not that there are issues in the tutorial itself.

markus2330 avatar Mar 05 '22 12:03 markus2330

We ( @leothetryhard and @lukashartl ) would like to work on this issue.

  • Should we go with TODO or DEPRECATED?
  • What exactly do you mean with marker? Is this something out of Doxygen, or just a prefix in the header?
  • Should we work through all the docs or just the mentioned array tutorial?

lukashartl avatar Mar 27 '22 08:03 lukashartl

If you want to work on the issue forget about TODO or DEPRECATED :wink: This was only for the case if nobody wants to update the tutorial.

The proper fix is to update the tutorial to the new array syntax (i.e. without leading underscores) and also explain that these underscores get added for arrays. In doc/KEYNAMES.md you can read about how the syntax currently is.

markus2330 avatar Mar 27 '22 16:03 markus2330

Should we work through all the docs or just the mentioned array tutorial?

You probably will not spot what is outdated. Afaik the array tutorial is the only one that has a known problem.

But of course: if you go through some docu and spot a problem, please report.

markus2330 avatar Mar 27 '22 16:03 markus2330