2009/11/9 Hannes Magnusson <hannes.magnus...@gmail.com>:
> Woha.
>
> We have a role="errors" section which I feel we use waaay to little.
>
> What do you guys think about moving the return values on failure to
> that section?
>
> -Hannes
>
>
> ---------- Forwarded message ----------
> From: Richard Quadling <rquadl...@php.net>
> Date: Mon, Nov 9, 2009 at 11:26
> Subject: [DOC-CVS] svn: /phpdoc/en/trunk/ appendices/about.xml
> reference/apache/functions/apache-get-version.xml
> reference/apache/functions/apache-response-headers.xml
> reference/apc/functions/apc-cache-info.xml
> reference/crack/functions/crack-opendict.xml
> reference/cyrus/functions/cyrus-connect.xml
> reference/datetime/datetime/format.xml
> reference/datetime/datetime/getoffset.xml
> reference/datetime/datetime/gettimezone.xml
> reference/datetime/datetimezone/getoffset.xml
> reference/datetime/datetimezone/gettransitions.xml
> reference/datetime/datetimezone/listabbreviations.xml
> reference/datetime/datetimezone/listidentifiers.xml
> reference/datetime/functions/date-create.xml
> reference/datetime/functions/date-parse.xml
> reference/datetime/functions/date-sun-info.xml
> reference/datetime/functions/date-sunrise.xml
> reference/datetime/functions/date-sunset.xml
> reference/datetime/functions/strptime.xml
> reference/datetime/functions/timezone-name-from-abbr.xml
> reference/dba/functions/dba-firstke
> To: doc-...@lists.php.net
>
>
> rquadling                                Mon, 09 Nov 2009 10:26:08 +0000
>
> Revision: http://svn.php.net/viewvc?view=revision&revision=290410
>
> Log:
> Use &return.falseforfailure; entity.
>
> Changed paths:
>    U   phpdoc/en/trunk/appendices/about.xml
>    U   phpdoc/en/trunk/reference/apache/functions/apache-get-version.xml
>    U   phpdoc/en/trunk/reference/apache/functions/apache-response-headers.xml
>    U   phpdoc/en/trunk/reference/apc/functions/apc-cache-info.xml
>    U   phpdoc/en/trunk/reference/crack/functions/crack-opendict.xml
>    U   phpdoc/en/trunk/reference/cyrus/functions/cyrus-connect.xml
>    U   phpdoc/en/trunk/reference/datetime/datetime/format.xml
>    U   phpdoc/en/trunk/reference/datetime/datetime/getoffset.xml
>    U   phpdoc/en/trunk/reference/datetime/datetime/gettimezone.xml
>    U   phpdoc/en/trunk/reference/datetime/datetimezone/getoffset.xml
>    U   phpdoc/en/trunk/reference/datetime/datetimezone/gettransitions.xml
>    U   phpdoc/en/trunk/reference/datetime/datetimezone/listabbreviations.xml
>    U   phpdoc/en/trunk/reference/datetime/datetimezone/listidentifiers.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/date-create.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/date-parse.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/date-sun-info.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/date-sunrise.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/date-sunset.xml
>    U   phpdoc/en/trunk/reference/datetime/functions/strptime.xml
>    U   
> phpdoc/en/trunk/reference/datetime/functions/timezone-name-from-abbr.xml
>    U   phpdoc/en/trunk/reference/dba/functions/dba-firstkey.xml
>    U   phpdoc/en/trunk/reference/dba/functions/dba-nextkey.xml
>    U   phpdoc/en/trunk/reference/dba/functions/dba-open.xml
>    U   phpdoc/en/trunk/reference/dba/functions/dba-popen.xml
>    U   phpdoc/en/trunk/reference/dir/functions/readdir.xml
>    U   phpdoc/en/trunk/reference/domxml/functions/DomNode-append-child.xml
>    U   
> phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-dict.xml
>    U   
> phpdoc/en/trunk/reference/enchant/functions/enchant-broker-request-pwl-dict.xml
>    U   phpdoc/en/trunk/reference/fileinfo/functions/finfo-open.xml
>    U   phpdoc/en/trunk/reference/filesystem/functions/file-get-contents.xml
>    U   phpdoc/en/trunk/reference/filesystem/functions/fputcsv.xml
>    U   phpdoc/en/trunk/reference/filesystem/functions/tmpfile.xml
>    U   phpdoc/en/trunk/reference/fribidi/functions/fribidi-log2vis.xml
>    U   phpdoc/en/trunk/reference/gearman/gearmantask/create.xml
>    U   phpdoc/en/trunk/reference/http/HttpDeflateStream/flush.xml
>    U   phpdoc/en/trunk/reference/http/HttpDeflateStream/update.xml
>    U   phpdoc/en/trunk/reference/http/HttpInflateStream/flush.xml
>    U   phpdoc/en/trunk/reference/http/HttpInflateStream/update.xml
>    U   phpdoc/en/trunk/reference/http/HttpResponse/guessContentType.xml
>    U   
> phpdoc/en/trunk/reference/http/functions/encodings/http-chunked-decode.xml
>    U   phpdoc/en/trunk/reference/http/functions/parsers/http-parse-cookie.xml
>    U   phpdoc/en/trunk/reference/http/functions/parsers/http-parse-headers.xml
>    U   
> phpdoc/en/trunk/reference/http/functions/persistenthandles/http-persistent-handles-count.xml
>    U   
> phpdoc/en/trunk/reference/http/functions/persistenthandles/http-persistent-handles-ident.xml
>    U   
> phpdoc/en/trunk/reference/http/functions/requests/http-request-method-name.xml
>    U   phpdoc/en/trunk/reference/http/functions/urls/http-build-str.xml
>    U   phpdoc/en/trunk/reference/http/functions/urls/http-build-url.xml
>    U   phpdoc/en/trunk/reference/ibase/functions/ibase-blob-create.xml
>    U   phpdoc/en/trunk/reference/ibase/functions/ibase-blob-open.xml
>    U   phpdoc/en/trunk/reference/ibm_db2/functions/db2-get-option.xml
>    U   phpdoc/en/trunk/reference/iconv/functions/iconv-get-encoding.xml
>    U   phpdoc/en/trunk/reference/iconv/functions/iconv.xml
>    U   phpdoc/en/trunk/reference/info/functions/set-include-path.xml
>    U   phpdoc/en/trunk/reference/ingres-ii/functions/ingres-connect.xml
>    U   phpdoc/en/trunk/reference/ingres-ii/functions/ingres-field-name.xml
>    U   phpdoc/en/trunk/reference/ingres-ii/functions/ingres-field-type.xml
>    U   phpdoc/en/trunk/reference/ingres-ii/functions/ingres-pconnect.xml
>    U   phpdoc/en/trunk/reference/kadm5/functions/kadm5-get-policies.xml
>    U   phpdoc/en/trunk/reference/kadm5/functions/kadm5-get-principal.xml
>    U   phpdoc/en/trunk/reference/kadm5/functions/kadm5-get-principals.xml
>    U   phpdoc/en/trunk/reference/kadm5/functions/kadm5-init-with-password.xml
>    U   phpdoc/en/trunk/reference/maxdb/functions/maxdb-connect.xml
>    U   phpdoc/en/trunk/reference/maxdb/functions/maxdb-fetch-lengths.xml
>    U   phpdoc/en/trunk/reference/memcache/functions/memcache-decrement.xml
>    U   phpdoc/en/trunk/reference/memcache/functions/memcache-getstats.xml
>    U   phpdoc/en/trunk/reference/memcache/functions/memcache-getversion.xml
>    U   phpdoc/en/trunk/reference/memcache/functions/memcache-increment.xml
>    U   phpdoc/en/trunk/reference/memcached/memcached/decrement.xml
>    U   phpdoc/en/trunk/reference/memcached/memcached/fetchall.xml
>    U   phpdoc/en/trunk/reference/memcached/memcached/getmulti.xml
>    U   phpdoc/en/trunk/reference/memcached/memcached/getmultibykey.xml
>    U   phpdoc/en/trunk/reference/memcached/memcached/increment.xml
>    U   
> phpdoc/en/trunk/reference/mnogosearch/functions/udm-alloc-agent-array.xml
>    U   phpdoc/en/trunk/reference/mnogosearch/functions/udm-find.xml
>    U   phpdoc/en/trunk/reference/msql/functions/msql-field-name.xml
>    U   phpdoc/en/trunk/reference/msql/functions/msql-field-table.xml
>    U   phpdoc/en/trunk/reference/mssql/functions/mssql-field-length.xml
>    U   phpdoc/en/trunk/reference/mssql/functions/mssql-field-name.xml
>    U   phpdoc/en/trunk/reference/mssql/functions/mssql-field-type.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-connect.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-fetch-lengths.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-field-flags.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-field-len.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-field-name.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-get-host-info.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-get-proto-info.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-get-server-info.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-list-processes.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-list-tables.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-num-fields.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-num-rows.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-tablename.xml
>    U   phpdoc/en/trunk/reference/mysql/functions/mysql-thread-id.xml
>    U   phpdoc/en/trunk/reference/network/functions/inet-ntop.xml
>    U   phpdoc/en/trunk/reference/openal/functions/openal-buffer-get.xml
>    U   phpdoc/en/trunk/reference/openal/functions/openal-listener-get.xml
>    U   phpdoc/en/trunk/reference/openal/functions/openal-source-get.xml
>    U   phpdoc/en/trunk/reference/openal/functions/openal-stream.xml
>    U   phpdoc/en/trunk/reference/openssl/functions/openssl-decrypt.xml
>    U   phpdoc/en/trunk/reference/openssl/functions/openssl-dh-compute-key.xml
>    U   phpdoc/en/trunk/reference/openssl/functions/openssl-digest.xml
>    U   phpdoc/en/trunk/reference/openssl/functions/openssl-encrypt.xml
>    U   phpdoc/en/trunk/reference/openssl/functions/openssl-x509-read.xml
>    U   phpdoc/en/trunk/reference/paradox/functions/px-get-parameter.xml
>    U   phpdoc/en/trunk/reference/paradox/functions/px-get-value.xml
>    U   phpdoc/en/trunk/reference/paradox/functions/px-set-tablename.xml
>    U   phpdoc/en/trunk/reference/pdo/pdostatement/setfetchmode.xml
>    U   phpdoc/en/trunk/reference/pdo_pgsql/functions/PDO-pgsqlLOBOpen.xml
>    U   phpdoc/en/trunk/reference/pgsql/functions/pg-execute.xml
>    U   phpdoc/en/trunk/reference/pgsql/functions/pg-prepare.xml
>    U   phpdoc/en/trunk/reference/pgsql/functions/pg-query-params.xml
>    U   phpdoc/en/trunk/reference/pgsql/functions/pg-query.xml
>    U   
> phpdoc/en/trunk/reference/printer/functions/printer-logical-fontheight.xml
>    U   phpdoc/en/trunk/reference/printer/functions/printer-open.xml
>    U   phpdoc/en/trunk/reference/ps/functions/ps-close-image.xml
>    U   phpdoc/en/trunk/reference/ps/functions/ps-new.xml
>    U   phpdoc/en/trunk/reference/pspell/functions/pspell-new.xml
>    U   phpdoc/en/trunk/reference/shmop/functions/shmop-read.xml
>    U   phpdoc/en/trunk/reference/simplexml/functions/simplexml-import-dom.xml
>    U   phpdoc/en/trunk/reference/solr/solrinputdocument/getfieldcount.xml
>    U   phpdoc/en/trunk/reference/solr/solrutils/escapequerychars.xml
>    U   phpdoc/en/trunk/reference/sphinx/sphinxclient/buildexcerpts.xml
>    U   phpdoc/en/trunk/reference/sqlite/functions/sqlite-query.xml
>    U   phpdoc/en/trunk/reference/sqlite/functions/sqlite-unbuffered-query.xml
>    U   phpdoc/en/trunk/reference/sqlite3/sqlite3/prepare.xml
>    U   phpdoc/en/trunk/reference/ssh2/functions/ssh2-exec.xml
>    U   phpdoc/en/trunk/reference/ssh2/functions/ssh2-publickey-init.xml
>    U   phpdoc/en/trunk/reference/stomp/stomp/getsessionid.xml
>    U   phpdoc/en/trunk/reference/stream/functions/stream-filter-append.xml
>    U   phpdoc/en/trunk/reference/stream/functions/stream-filter-prepend.xml
>    U   phpdoc/en/trunk/reference/stream/functions/stream-get-contents.xml
>    U   phpdoc/en/trunk/reference/unicode/functions/unicode-decode.xml
>    U   phpdoc/en/trunk/reference/unicode/functions/unicode-encode.xml
>    U   phpdoc/en/trunk/reference/unicode/functions/unicode-get-error-mode.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-columnprivileges.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-columns.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-foreignkeys.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-primarykeys.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-procedurecolumns.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-procedures.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-statistics.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-tableprivileges.xml
>    U   phpdoc/en/trunk/reference/uodbc/functions/odbc-tables.xml
>    U   phpdoc/en/trunk/reference/url/functions/base64-decode.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getarchivecomment.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getcommentindex.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getcommentname.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getfromindex.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getfromname.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getnameindex.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getstatusstring.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/getstream.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/locatename.xml
>    U   phpdoc/en/trunk/reference/zip/ziparchive/statindex.xml
>
>
> --
> PHP Documentation Commits Mailing List (http://www.php.net/)
> To unsubscribe, visit: http://www.php.net/unsub.php
>

I think in some cases an example of what creates the error/exception
is useful. It can clearly show what is going wrong and why.

But on the other hand, do we (ahem) want to be adding examples which
are intentionally flawed?




-- 
-----
Richard Quadling
"Standing on the shoulders of some very clever giants!"
EE : http://www.experts-exchange.com/M_248814.html
Zend Certified Engineer : http://zend.com/zce.php?c=ZEND002498&r=213474731
ZOPA : http://uk.zopa.com/member/RQuadling

Reply via email to