SRL Archive - MSI Suggestions

Long ago we discussed we should have rev # and date on the function headers.

Rev # seems a bit stupid when I thnk about it again. Annoying to keep track of, with git rev numbers might not be as easy to match, and truth be told I never saw anyone care about rev #.

Date however is still something that should be included. It will be good for history's sake and to keep track of what might need updating.

Everything atm is supposedly up to date. So I'd suggest adding today's date to everything. If none does it, once I can I will.

Here is how it had planned to be added:
[php]
{******************************************************************************}
{ function SetUpWalk(City, WhereTo: integer): TWalk; }
{ By: Rasta Magician
{ Date: 30 May 2010 }
{ Description: Returns a TWalk, depending on City and desired destination }
{******************************************************************************}
[/php]

DD MMM YYYY

~RM

If simba included the neat (menu–>insert date time function) datetime function then you could just do Date: F5 done.
Btw, your example is not equal to your date time format.

From: Hermen
If simba included the neat (menu–>insert date time function) datetime function then you could just do Date: F5 done.
Btw, your example is not equal to your date time format.

it is?

30 May 2010
DD MMM YYYY

~RM

I think this was discussed in the thread I made about the Pre-release Organization or something like that. I didn't really think it was necessary, but I guess it's good to have just in case.

E: We could take out credits as (I think) SRL 5 is going to be like that, but it doesn't matter to me.

does the maker of the function really matter? Its not necessary and it doesn't really add anything to the documentation. Its part of SRL, afaik devs of other projects don't generally give individual credit for each bit of code contributed.

From: Dan Cardin
does the maker of the function really matter? Its not necessary and it doesn't really add anything to the documentation. Its part of SRL, afaik devs of other projects don't generally give individual credit for each bit of code contributed.

Today I got a PM from lord saturn about SmartColors. I wonder if I would've got that PM if my name had not been stamped on there.

~RM

you might not have, it might have gone to someone else who knew the function or to a developer who ought to know how it works anyway.

From: Rasta Magician
Today I got a PM from lord saturn about SmartColors. I wonder if I would've got that PM if my name had not been stamped on there.

~RM

Otherwise he might have posted the question (if it was a question) and the answer would be on the forum for future purpose.

I still think that the credits being there gives some people a reason to script for the include, and if it is something that makes people script then it is worth having there. I guess we'll just wait to see what the decision for SRL 5 is.

~RM

Yeah, I agree on that one :) But I don't think we should call it Author or By, I like something like Contributors more.

From: nielsie95
Yeah, I agree on that one :) But I don't think we should call it Author or By, I like something like Contributors more.

Sounds good to me.

~RM

I assume the date is for "last modified"? Or is it for "created"?
In either way, should change it into a more informative word IMO.

Oh, and; keep the "author"-part. No doubt. /care about credits and glory and whatnot, but as RM stated an example of, it no doubt saves you quite some bothersome steps in certain situations.

I like the 'Contributors' better. Just keep the main contributors first on the list.

Yes, date for last modified.

About more info on those, I was reading around SRL 5 and nielsie's suggestion of PHP Doc-like documentation. Once we settle that for SRL 5 I'll get it settled here.

~RM

From: Rasta Magician
I like the 'Contributors' better. Just keep the main contributors first on the list.

Yes, date for last modified.

About more info on those, I was reading around SRL 5 and nielsie's suggestion of PHP Doc-like documentation. Once we settle that for SRL 5 I'll get it settled here.

~RM

Last I heard, Nava was writing one in Python. Not sure how far he got though.

I've been wanting a php doc for a long while for both SCAR and SRL. I guess its kind of what Freddy was aiming for with his wiki, but no one contributed and i think whatever the people at php have its very nice. If you're going to go for that, then I think there would be the place to have the contributors. I don't see any point for it being there, but if you really feel that it's good to have, then it would be best placed in the docs instead of the include.

Added dates to all the headers.