Welcome Guest, Not a member yet? Register   Sign In
Documentation omissions
#3

[eluser]a&w[/eluser]
I think consider my comments to be observations. On one hand you're ultimately more famila with the docs so would presumably know what should or should not be included. On the other hand, as someone not as familiar, to which maybe the docs are really for (?) then it might make sense to document it.

If it's documented elsewhere I would not repeat, just as a link to that part of the docs so you're not repeating and maintaining multiple locations with updates.

If the other method is no longer preferred then I'd say probably don't document it, or include in the doc but point someone towards the preferred way to do it. I only went looking for it browsing someone else's code who used it and wondered what it was, and had to go digging into the source to find out.


Messages In This Thread
Documentation omissions - by El Forum - 07-11-2008, 05:55 PM
Documentation omissions - by El Forum - 07-16-2008, 07:53 AM
Documentation omissions - by El Forum - 07-16-2008, 10:14 AM
Documentation omissions - by El Forum - 07-16-2008, 10:21 AM



Theme © iAndrew 2016 - Forum software by © MyBB