Skip to content

Commit 65ce6dd

Browse files
dabrahamsdabrahams
committed
doc update
[SVN r15596]
1 parent fa7b140 commit 65ce6dd

3 files changed

Lines changed: 28 additions & 16 deletions

File tree

‎doc/v2/class.html‎

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,7 @@ <h4><a name="class_-spec-synopsis"></a>Class template <code>class_</code>
247247
namespace boost { namespace python
248248
{
249249
template &lt;class T
250-
<font color="#007F00"> , class Bases = bases&lt;&gt;
250+
<font color="#007F00"> , class Bases = bases&lt;&gt;
251251
, class HeldType = T
252252
, class NonCopyable = <i>unspecified</i>
253253
&gt;
@@ -319,7 +319,7 @@ <h4><a name="class_-spec-ctors"></a>Class template <code>class_</code>
319319
</pre>
320320

321321
<dl class="function-semantics">
322-
<dt><b>Requires:</b> <code>name</code> is a <a href=
322+
<dt><b>Requires:</b> <code>name</code> is an <a href=
323323
"definitions.html#ntbs">ntbs</a> which conforms to Python's <a href=
324324
"http://www.python.org/doc/current/ref/identifiers.html">identifier
325325
naming rules</a>. If <code>docstring</code> is supplied, it must be an
@@ -404,7 +404,7 @@ <h4><a name="class_-spec-modifiers"></a>Class template
404404
</pre>
405405

406406
<dl class="function-semantics">
407-
<dt><b>Requires:</b> <code>name</code> is a <a href=
407+
<dt><b>Requires:</b> <code>name</code> is an <a href=
408408
"definitions.html#ntbs">ntbs</a> which conforms to Python's <a href=
409409
"http://www.python.org/doc/current/ref/identifiers.html">identifier
410410
naming rules</a>.</dt>
@@ -414,8 +414,9 @@ <h4><a name="class_-spec-modifiers"></a>Class template
414414
<li>
415415
If <code>a1</code> is the result of an <a href=
416416
"OverloadDispatch.html"><em>overload-dispatch-expression</em></a>,
417-
only the second is allowed and fn must be a pointer to [member]
418-
function whose signature is compatible with A1.
417+
only the second is allowed and fn must be a pointer to
418+
function or pointer to member function whose signature is
419+
compatible with A1.
419420

420421
<dl>
421422
<dt><b>Effects:</b> For each <a href=
@@ -526,8 +527,8 @@ <h4><a name="class_-spec-modifiers"></a>Class template
526527
</pre>
527528

528529
<dl class="function-semantics">
529-
<dt><b>Requires:</b> <code>name</code> is a ntbs which conforms to
530-
Python's <a href=
530+
<dt><b>Requires:</b> <code>name</code> is an <a href=
531+
"definitions.html#ntbs">ntbs</a> which conforms to Python's <a href=
531532
"http://www.python.org/doc/current/ref/identifiers.html">identifier
532533
naming rules</a>.</dt>
533534

@@ -554,8 +555,8 @@ <h4><a name="class_-spec-modifiers"></a>Class template
554555
</pre>
555556

556557
<dl class="function-semantics">
557-
<dt><b>Requires:</b> <code>name</code> is a ntbs which conforms to
558-
Python's <a href=
558+
<dt><b>Requires:</b> <code>name</code> is an <a href=
559+
"definitions.html#ntbs">ntbs</a> which conforms to Python's <a href=
559560
"http://www.python.org/doc/current/ref/identifiers.html">identifier
560561
naming rules</a>.</dt>
561562

@@ -580,8 +581,8 @@ <h4><a name="class_-spec-modifiers"></a>Class template
580581
</pre>
581582

582583
<dl class="function-semantics">
583-
<dt><b>Requires:</b> <code>name</code> is a ntbs which conforms to
584-
Python's <a href=
584+
<dt><b>Requires:</b> <code>name</code> is an <a href=
585+
"definitions.html#ntbs">ntbs</a> which conforms to Python's <a href=
585586
"http://www.python.org/doc/current/ref/identifiers.html">identifier
586587
naming rules</a>.</dt>
587588

@@ -733,7 +734,7 @@ <h4><a name="init-spec-observers"></a>Class template <code>init</code>
733734
<dt><b>Effects:</b> Returns a new <a href=
734735
"#init-expressions"><em>init-expression</em></a> with all the same
735736
properties as the <code>init</code> object except that its
736-
<em>callpolicies</em> are replaced by a reference to
737+
<em>call policies</em> are replaced by a reference to
737738
<code>policies</code>.</dt>
738739
</dl>
739740

@@ -750,8 +751,8 @@ <h4><a name="init-expressions"><em>init-expressions</em></a></h4>
750751

751752
<dt><b>keywords:</b> A <a href=
752753
"args.html#keyword-expression">keyword-expression</a> which will be
753-
used to name (a trailing subsequence of) the arguments to the generated
754-
<code>__init__</code> function(s).</dt>
754+
used to name (a trailing subsequence of) the arguments to the
755+
generated <code>__init__</code> function(s).</dt>
755756

756757
<dt><b>call policies:</b> An instance of a model of <a href=
757758
"CallPolicies.html">CallPolicies</a>.</dt>

‎doc/v2/definitions.html‎

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,12 +37,23 @@ <h2 align="center">Definitions</h2>
3737
<dt><b><a name="ntbs">ntbs</a>:</b> Null-Terminated Byte String, or
3838
`C'-string. C++ string literals are <strong>ntbs</strong>es. An
3939
<strong>ntbs</strong> must never be null.</dt>
40+
41+
<dt><b><a name="raise">raise</a>:</b> Exceptions in Python are
42+
&quot;raised&quot;, not &quot;thrown&quot;, as they are in
43+
C++. When this documentation says that some Python exception is
44+
&quot;raised&quot; in the context of C++ code, it means that the
45+
corresponding Python exception is set via the <a
46+
href="http://www.python.org/doc/current/api/exceptionHandling.html">Python/'C'
47+
API</a>, and <code><a
48+
href="errors.html#throw_error_already_set-spec">throw_error_already_set</a>()</code>
49+
is called.</dt>
50+
4051
</dl>
4152
<hr>
4253

4354
<p>Revised
4455
<!--webbot bot="Timestamp" S-Type="EDITED" S-Format="%d %B, %Y" startspan -->
45-
28 September, 2002
56+
30 September, 2002
4657
<!--webbot bot="Timestamp" endspan i-checksum="39359" -->
4758
</p>
4859

‎doc/v2/extract.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ <h2><a name="examples"></a>Examples</h2>
192192

193193
The following example shows how extract can be used along with
194194
<code><a
195-
href="class.html#class-spec">class_</a>&lt;</code>...<code>&gt;</code>
195+
href="class.html#class_-spec">class_</a>&lt;</code>...<code>&gt;</code>
196196
to create and access an instance of a wrapped C++ class.
197197

198198
<pre>

0 commit comments

Comments
 (0)