summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHugo Parente Lima <hugo.pl@gmail.com>2011-07-20 15:45:25 -0300
committerHugo Parente Lima <hugo.pl@gmail.com>2011-07-20 16:44:14 -0300
commitf893043a91330e60d896ec51a6f9fd6937fd6987 (patch)
treeb86c5cc58457133217a5600bb0b020accf63f843
parent0a41e336ba25df2d87218555a3a15f96dcc3ec77 (diff)
downloadpyside-f893043a91330e60d896ec51a6f9fd6937fd6987.tar.gz
pyside-f893043a91330e60d896ec51a6f9fd6937fd6987.tar.xz
pyside-f893043a91330e60d896ec51a6f9fd6937fd6987.zip
Fix bug 916 - "Missing info about when is possible to use keyword arguments in docs [was: QListWidgetItem's constructor ignores text parameter]"
Reviewer: Luciano Wolf <luciano.wolf@openbossa.org> Marcelo Lira <marcelo.lira@openbossa.org>
-rw-r--r--doc/_templates/index.html14
1 files changed, 10 insertions, 4 deletions
diff --git a/doc/_templates/index.html b/doc/_templates/index.html
index fc1b208..ee63b17 100644
--- a/doc/_templates/index.html
+++ b/doc/_templates/index.html
@@ -11,11 +11,17 @@
<p>PySide is built using the <a href="http://www.pyside.org/docs/shiboken">Shiboken</a> binding generator.</p>
- <h2>Modules</h2>
+ <h2>Notes</h2>
+
+ <h3>About 0 vs None</h3>
+
+ <p>The PySide class reference documentation is automatically generated from the original Qt documentation for C++, some parts were tuned to fit the Python world, however is not possible to rewrite all Qt docs as it would require a really huge effort, so if the documentation says you can use 0 on an QObject argument, interpret it as None.</p>
- <div class="admonition warning">
- <strong>Note:</strong> The PySide class reference documentation is automatically generated from the original Qt documentation for C++, some parts were tuned to fit the Python world, however is not possible to rewrite all Qt docs as it would require a really huge effort, so if the documentation says you can use 0 on an QObject argument, interpret it as None.
- </div>
+ <h3>About keyword arguments</h3>
+
+ <p>Only optional arguments can be used as keyword arguments.</p>
+
+ <h2>Modules</h2>
<table class="contentstable" align="center" ><tr>
<td width="50%">