public inbox for archer@sourceware.org
 help / color / mirror / Atom feed
* [python] Mention Python help command and keyword arguments convention.
@ 2009-02-27 20:00 Thiago Jung Bauermann
  0 siblings, 0 replies; only message in thread
From: Thiago Jung Bauermann @ 2009-02-27 20:00 UTC (permalink / raw)
  To: archer ml

Hi,

Just pushed this.
    
gdb/doc/
	* gdb.texinfo (Python API): Mention python help command and
	convention for accepting keyword arguments.

diff --git a/gdb/doc/gdb.texinfo b/gdb/doc/gdb.texinfo
index 67c0ae3..d055353 100644
--- a/gdb/doc/gdb.texinfo
+++ b/gdb/doc/gdb.texinfo
@@ -18114,6 +18114,14 @@ auto-loading is disabled.
 @cindex python api
 @cindex programming in python
 
+You can get quick online help for @value{GDBN}'s Python API by issuing
+the command @w{@kbd{python help (gdb)}}.
+
+Functions and methods which have two or more optional arguments allow
+them to be specified using keyword syntax.  This allows passing some
+optional arguments while skipping others.  Example:
+@w{@code{gdb.some_function ('foo', bar = 1, baz = 2)}}.
+
 @cindex python stdout
 @cindex python pagination
 At startup, @value{GDBN} overrides Python's @code{sys.stdout} and


^ permalink raw reply	[flat|nested] only message in thread

only message in thread, other threads:[~2009-02-27 20:00 UTC | newest]

Thread overview: (only message) (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2009-02-27 20:00 [python] Mention Python help command and keyword arguments convention Thiago Jung Bauermann

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).