Forum > Documentation (Maintaining -)
Improving the "Data Structure, Containers, Collections" and Generics wiki pages
jouborg:
I'm new to fpc/Lazarus but am a seasoned software engineer.
As a newcomer, I found that the Data Structures, Containers, Collections page page and the Generics page led me down a path selecting collection classes from the FGL instead of the more modern (and recommended?) Generics.Collections from the RTL.
There are at least 3 things that I am motivated to address which I think will make the docs more effective for programmers:
- section order (i.e. put the recommended first, instead of "telling the history")
- emphasis (e.g. on the Generics page, the getting started points to the fgl unit, instead of the Generics.Collections)
- examples
Any objection if I proceed to make these modifications? Any other feedback?
egsuh:
There should be much improvements and more documentations for Lazarus/Free Pascal.
On the Data Structures... page, I trid to see contents of TPair, TSortedArray, and TValTree, etc., but I cannot find any explanation on them.
trev:
--- Quote from: jouborg on December 24, 2020, 11:07:16 pm ---Any objection if I proceed to make these modifications? Any other feedback?
--- End quote ---
No, feel free to go ahead. The Wiki harvest could be great, but the labourers are few.
trev:
--- Quote from: egsuh on December 25, 2020, 12:08:22 am ---There should be much improvements and more documentations for Lazarus/Free Pascal.
--- End quote ---
It's a collaborative endeavour, so feel free to add improvements and any missing documentation.
lucamar:
Both pages could be improved but I'd not change much of "Data_Structures, Containers, Collections"; it's mostly an index and I think its structure reflects rather well what it's about, though its contents seem to be a little dated. "Generics" is another kettle of fish: that one really needs a full overhaul.
So go ahead and improve: it's a wiki so if anyone doesn't like what you do (s)he can always undo it or change it to whatever (s)he feels it should be ;)
Just one thing: when adding "content" try to use the best English of which you're capable and, if anything, over-explain any feature/example. The wiki is frequently the first stop for newbies and even mid-level programmers and while it cannot (and shouldn't, IMHO) replace the formal documentation, it should nevetheless be kept/modified to a somewhat "high" standard; as if it were, say, parts of a "course book". You're a software engineer so you know what I mean, I think :)
Navigation
[0] Message Index
[#] Next page