[Bug python/16484] New: Frame.block documentation incomplete

[tromey at redhat dot com]

https://sourceware.org/bugzilla/show_bug.cgi?id=16484

Bug ID: 16484
Summary: Frame.block documentation incomplete
Product: gdb
Version: HEAD
Status: NEW
Severity: normal
Priority: P2
Component: python
Assignee: unassigned at sourceware dot org
Reporter: tromey at redhat dot com

Frame.block's docs just say:

-- Function: Frame.block ()
Return the frame's code block. *Note Blocks In Python::.


However it ought to mention that if the frame does not have
a block, then an exception is thrown.

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=16484

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
CC| |tromey at sourceware dot org
Assignee|unassigned at sourceware dot org |tromey at sourceware dot org

[cvs-commit at gcc dot gnu.org]

https://sourceware.org/bugzilla/show_bug.cgi?id=16484

--- Comment #1 from cvs-commit at gcc dot gnu.org <cvs-commit at gcc dot gnu.org> ---
The master branch has been updated by Tom Tromey <***@sourceware.org>:

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=60c0454d3dda99635d331f6002f3f04fe34546a7

commit 60c0454d3dda99635d331f6002f3f04fe34546a7
Author: Tom Tromey <***@tromey.com>
Date: Sat Sep 8 09:08:56 2018 -0600

Document that Frame.block can throw

PR python/16484 points out that Frame.block can throw an exception,
but this is not documented.

This patch fixes the documentation. Changing Frame.block to return
None would be nice, but I suspect it's too late for that change.

gdb/doc/ChangeLog
2018-09-10 Tom Tromey <***@tromey.com>

PR python/16484:
* python.texi (Frames In Python): Document that Frame.block can
throw.

[tromey at sourceware dot org]

https://sourceware.org/bugzilla/show_bug.cgi?id=16484

Tom Tromey <tromey at sourceware dot org> changed:

What |Removed |Added
----------------------------------------------------------------------------
Status|NEW |RESOLVED
Resolution|--- |FIXED
Target Milestone|--- |8.3

--- Comment #2 from Tom Tromey <tromey at sourceware dot org> ---
Fixed.