BIND 10 #1483: "findAll" method for ZoneFinder
BIND 10 Development
do-not-reply at isc.org
Mon Dec 19 17:13:53 UTC 2011
#1483: "findAll" method for ZoneFinder
-------------------------------------+-------------------------------------
Reporter: | Owner: jelte
jinmei | Status: reviewing
Type: task | Milestone:
Priority: major | Sprint-20111220
Component: data | Resolution:
source | Sensitive: 0
Keywords: | Sub-Project: DNS
Defect Severity: N/A | Estimated Difficulty: 0
Feature Depending on Ticket: DDNS | Total Hours: 0
Add Hours to Ticket: 0 |
Internal?: 0 |
-------------------------------------+-------------------------------------
Changes (by vorner):
* owner: vorner => jelte
Comment:
Hello
Replying to [comment:13 jelte]:
> hmm, perhaps we should consider raising an exception if a log message
contains the wrong number of arguments. Alternatively or additionally,
perhaps we should consider not doing indirect log calls (where the log
message id is passed to a function that calls the log message) in the
first place. The latter would certainly make a script that runs through
the code and performs these checks a lot easier (I do not believe we can
have both complete and sound checks for this by doing unit tests and
checking log output).
As it seems there's not much consensus about if to allow different number
of parameters or not on jabber, I'd propose moving on and leaving this for
discussion and other ticket.
> > I believe the actual documentation quality is more important than
having no warnings, that's why I wouldn't like to „fix“ it. But it is
possible I don't see some other way than copy-pasting and having it twice
would be actually helpful for user (I don't see how, though).
> >
>
> One risk of not 'fixing' them is that we may forget to document parts
that do not have such a reference (which is the reason Jeremy wants this
to be done, and I tend to agree with him here).
>
> Hmm, what about compromise, and give each parameter the description "See
<other method>", or even "see other-parameter-of-other-method", if doxygen
supports such a construct (doesn't solve the longer and repetetive one,
although it does make the html output a bit nicer)?
I don't really like the compromise much and it doesn't produce very nice
output anyway. But I did it in the sake of moving forward. Is it OK now?
--
Ticket URL: <http://bind10.isc.org/ticket/1483#comment:14>
BIND 10 Development <http://bind10.isc.org>
BIND 10 Development
More information about the bind10-tickets
mailing list