Wireshark-bugs: [Wireshark-bugs] [Bug 6057] Lua API: add support to temporary color filters (10
Date: Mon, 27 Jun 2011 18:22:41 -0700 (PDT)
https://bugs.wireshark.org/bugzilla/show_bug.cgi?id=6057

--- Comment #5 from Tony Trinh <[email protected]> 2011-06-27 21:22:39 EDT ---
Hi Peter/Stig,

After digging around, I noticed a few minor documentation bugs at 
http://anonsvn.wireshark.org/viewvc/trunk/epan/wslua/wslua_gui.c?revision=37801&view=markup#l804.


1) The doc for `set_color_filter_slot()` indicates "Set color of the current
packet", but that's not really correct; it actually sets the packet-coloring
rule (by index) for the current *session*.


2) The description of the "row" parameter: 
  (a) "The row count" should really be "The row index" because a count is
normally based from 1, but the parameter passed to the underlying function is
zero-based (for which "index" is more appropriate).

  (b) It might help to describe the row's purpose (to select desired color)

  (c) Unless you know where to look in the code, "tmp filter list" is somewhat
of a mystery. How about "temporary coloring rules list" instead?

  Altogether would be something like: "The row index of the desired color in
the temporary coloring rules list"


3) The description of the "text" parameter: change from "Filter" to "Display
filter" to clarify which syntax to use. (Even better would be: "Display filter
for selecting packets to be colorized")


Best,
Tony

-- 
Configure bugmail: https://bugs.wireshark.org/bugzilla/userprefs.cgi?tab=email
------- You are receiving this mail because: -------
You are watching all bug changes.