[tor-commits] [tor/master] Clarify documentation on config_var_is_listable()

[dgoulet at torproject.org]

commit fe5033d3b0f618493ec8ffd4274352ed42835bdb
Author: Nick Mathewson <nickm at torproject.org>
Date:   Tue Sep 10 09:39:09 2019 -0400

    Clarify documentation on config_var_is_listable()
    
    Here we make it clear we're only looking at listable variable names,
    not at whether the variables themselves are gettable.
    
    Also, remove an extraneous h.
    
    (This commit is not a fixup, because of rebase conflicts.)
---
 src/app/config/confparse.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/src/app/config/confparse.c b/src/app/config/confparse.c
index dcbad0b90..930484620 100644
--- a/src/app/config/confparse.c
+++ b/src/app/config/confparse.c
@@ -589,9 +589,9 @@ config_var_needs_copy(const config_var_t *var)
   return ! config_var_has_flag(var, CFLG_NOCOPY);
 }
 
-/**h
- * Return true iff variable <b>var</b> should appear on list of variables
- * given to the controller or the CLI.
+/**
+ * Return true iff variable <b>var</b> should appear on list of variable
+ * names given to the controller or the CLI.
  **/
 bool
 config_var_is_listable(const config_var_t *var)