Foe function...

[borrofburi]

Lack of documentation is a no-no in an effective software solution

The documentation is perfectly fine so far as I see, in fact it's documented quite candidly.

 

[WarK]

Lack of documentation is a no-no in an effective software solution

The documentation is perfectly fine so far as I see, in fact it's documented quite candidly.

you could always dig through the source code

 

[FaithlessThinker]

The documentation is perfectly fine so far as I see, in fact it's documented quite candidly.

I'm not sure how you could call this a perfectly fine documentation:

TODO: ... Write a detailed explanation about what Friends and Foes are and how they affect the forum ...

 

[borrofburi]

The documentation is perfectly fine so far as I see, in fact it's documented quite candidly.

I'm not sure how you could call this a perfectly fine documentation:

TODO: ... Write a detailed explanation about what Friends and Foes are and how they affect the forum ...

When it includes the candid line "this doesn't really do anything yet...":

For 3.0 this does not have much of an influence on the overall forum experience

Essentially it says "Oi if this ever gets implemented/used, we'll need to write documentation for it, but for now it doesn't really do anything."

In fact I had a project complete just the other day where we had multiple TODOs in documentation for features that had neither been designed nor implemented yet. We eventually designed and implemented and documented them, but I can understand a situation where you create the backbone of a feature for future expansion (and the TODOs in the proper places to facilitate this expansion) and then other things are always more important, so you're left with skeleton code of a useless feature. Then the most useful documentation is simply the candid: this doesn't really do anything yet...

 

[FaithlessThinker]

When it includes the candid line "this doesn't really do anything yet...":

For 3.0 this does not have much of an influence on the overall forum experience

Essentially it says "Oi if this ever gets implemented/used, we'll need to write documentation for it, but for now it doesn't really do anything."

In fact I had a project complete just the other day where we had multiple TODOs in documentation for features that had neither been designed nor implemented yet. We eventually designed and implemented and documented them, but I can understand a situation where you create the backbone of a feature for future expansion (and the TODOs in the proper places to facilitate this expansion) and then other things are always more important, so you're left with skeleton code of a useless feature. Then the most useful documentation is simply the candid: this doesn't really do anything yet...

I see. Thanks.