Update gdb.Symbol.is_variable documentation
authorTom Tromey <tromey@adacore.com>
Tue, 31 Oct 2023 15:16:08 +0000 (09:16 -0600)
committerTom Tromey <tromey@adacore.com>
Tue, 14 Nov 2023 15:44:31 +0000 (08:44 -0700)
Kévin found a bug in an earlier version of this series that was based
on a misconception I had about Symbol.is_variable.  This patch fixes
the documentation to explain the method a bit better.

Approved-By: Eli Zaretskii <eliz@gnu.org>
gdb/doc/python.texi

index c3dfc7ae0faaa499da4cce29b33db9f1c15a282a..b65991bbad0c5ff72457dbbbf5fc51f03d837bab 100644 (file)
@@ -6052,7 +6052,9 @@ local variables will require a frame, but other symbols will not.
 @end defvar
 
 @defvar Symbol.is_variable
-@code{True} if the symbol is a variable.
+@code{True} if the symbol is a variable, as opposed to something like
+a function or type.  Note that this also returns @code{False} for
+arguments.
 @end defvar
 
 A @code{gdb.Symbol} object has the following methods: