Customizing SMF > SMF Coding Discussion

Documenting what is in the code

(1/4) > >>

emanuele:
This evening I started a page on my wiki userspace (or whatever is called) where I'd like to collect things about SMF code:
http://wiki.simplemachines.org/smf/User:Emanuele/codedoc

I started with $user_info['mod_cache'] because I was trying to use it and I was not sure what (the heck) was in that array.

Eventually I'll move it to a proper wiki page, so if you want to contribute (both writing something or fixing errors) feel free to! ;D

emanuele:
Added a (hopefully) completed documentation of createList.

AngelinaBelle:
This is a great start, emanuele.
Of course, it is very esoteric stuff -- completely incomprehensible to the uninitiated. And rightly so.  You learned it by immersing yourself in the code and trying things out to see what works (and does not work).
What pages do you think should like to these lists?
What warnings should be added -- some of this stuff is 2.1-only? Some of this stuff is the same in 2.0 and 2.1?

emanuele:

--- Quote from: AngelinaBelle on August 14, 2012, 09:06:58 AM ---This is a great start, emanuele.

--- End quote ---
Yes, exactly, it's just a start... there are many other things that would need documentation! :D


--- Quote from: AngelinaBelle on August 14, 2012, 09:06:58 AM ---Of course, it is very esoteric stuff -- completely incomprehensible to the uninitiated. And rightly so.  You learned it by immersing yourself in the code and trying things out to see what works (and does not work).

--- End quote ---
lol
No, not really, it's just stuff not frequently used (I feel mostly because people doesn't know either how to use it or it exists at all).
What is now missing are examples...later.


--- Quote from: AngelinaBelle on August 14, 2012, 09:06:58 AM ---What pages do you think should like to these lists?
--- End quote ---
No idea, there should be something related to development somewhere on the wiki, but I feel it is still a bit...not properly organised. :P


--- Quote from: AngelinaBelle on August 14, 2012, 09:06:58 AM ---What warnings should be added -- some of this stuff is 2.1-only? Some of this stuff is the same in 2.0 and 2.1?

--- End quote ---
AFAIK there are just two things in creteList that are not in 2.0 and I already marked them with "(2.1 only)" (that probably should be changed to "(starting from 2.1)", but that's not so urgent at the moment :P).

AngelinaBelle:

--- Quote from: emanuele on August 14, 2012, 03:24:26 PM ---
--- Quote from: AngelinaBelle on August 14, 2012, 09:06:58 AM ---What pages do you think should like to these lists?
--- End quote ---
No idea, there should be something related to development somewhere on the wiki, but I feel it is still a bit...not properly organised. :P

--- End quote ---
I agree -- not properly organized. And it sounds like you cannot even find a page that is a logical "starting point" to jump to all of this new material.  That is a bad situation! It sounds like something doc team should be helping with -- organizing.
I'll see if I can figure it out a little bit.

Navigation

[0] Message Index

[#] Next page