-On [20070124 15:28], Christopher Lenz ([EMAIL PROTECTED]) wrote:
>I think we should just use "render_macro2" in this case.

If you talk about API design I consider these kind of names the worst you
could use. It is not descriptive in the manner that it doesn't explain
immediately the difference between render_macro and render_macro2.

It reminds me of the same problems I encountered when having to document newer
IP stack function calls, e.g. gethostbyname() and gethostbyname2(). Quickly,
what's the difference? Indeed, you don't know without resorting to the
documentation and carefully comparing the two (hopefull having documentation
that's totally up-to-date with deprecation as well, which is definitely not
always the case).

But perhaps just my experience from a technical writer point of view after
having had to document too many of these kind of things. :)

-- 
Jeroen Ruigrok van der Werven <asmodai(-at-)in-nomine.org> / asmodai
イェルーン ラウフロック ヴァン デル ウェルヴェン
http://www.in-nomine.org/
There is no joy in smallness. Joy is in the infinite...

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups "Trac 
Development" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to [EMAIL PROTECTED]
For more options, visit this group at 
http://groups.google.com/group/trac-dev?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to