Re: [PHP-DOC] [Patch] Re: [PHP-DOC] ncurses documentation

[Keito Uchiyama]

Hannes Magnusson wrote:

Awesome work.
One thing I would update: +   Returns 0 on success, -1 if the color
table could not be allocated
(and all similar), use 0, -1..
it makes it more clear that these are actual return values.

-Hannes


Thanks Hannes! I've posted an updated patch with that change, and a few 
more improvements: 


Keito

Re: [PHP-DOC] warn.experimental.func

[Keito Uchiyama]

Hannes Magnusson wrote:

If the extension contains the file "EXPERIMENTAL" the author considers
the extension as experimental.
Why this file was deleted when ncurses was moved to pecl I don't know..
But, since it was removed, I think its ok to remove that warning from the docs.


I see. I'll remove the tag from the functions I've edited, and for the 
other functions as I write documentation for them.



Good point.. the text should probably just say "in the future", not
explicitly PHP..


Should language-snippets.ent be changed?

Keito

[PHP-DOC] warn.experimental.func

[Keito Uchiyama]

I have two questions: who/what decides if a function is "experimental", 
and when do they become non-experimental? Also, does the tag apply to 
PECL extensions (e.g. ncurses) as well, given that it disclaims against 
changes in "future versions of PHP"?


Thanks!

Keito

[PHP-DOC] CVS Account Request: keito

[Keito Uchiyama]

For contributing to PHP documentation, starting with complete documentation of 
the ncurses extension. Philip Olson (philip) referred me here.

Re: [PHP-DOC] [Patch] Re: [PHP-DOC] ncurses documentation

[Keito Uchiyama]

Philip Olson wrote:
Nice! :) But please post the patch as an attachment or a link online as 
it gets altered in email. And if you're planning on documenting more 
then a CVS account is appropriate:


  - http://php.net/cvs-php

As for the markup, the only problems I see are whitespace issues because 
for XML it should be one space indention. It may seem strict but overall 
it makes for clean source files. And wrapping should be around 72 
characters but that number is flexible.


Hi Philip,

Thanks! :) I've posted an updated version of the patch at 
.


Keito

[PHP-DOC] [Patch] Re: [PHP-DOC] ncurses documentation

[Keito Uchiyama]

Philip Olson wrote:

> Agreed, and I think it would be well worth it to document this extension.


I've gone ahead and documented the color-related functions in the 
ncurses extension, for starters.


Please let me know if there's anything I should fix!

Thanks,

Keito
Index: constants.xml
===
RCS file: /repository/phpdoc/en/reference/ncurses/constants.xml,v
retrieving revision 1.6
diff -u -r1.6 constants.xml
--- constants.xml   26 Jan 2008 14:49:36 -  1.6
+++ constants.xml   5 Apr 2009 04:52:29 -
@@ -6,7 +6,7 @@
  
   Error codes

-On error ncurses functions return NCURSES_ERR.
+On error ncurses functions return -1.

  
   
Index: versions.xml
===
RCS file: /repository/phpdoc/en/reference/ncurses/versions.xml,v
retrieving revision 1.1
diff -u -r1.1 versions.xml
--- versions.xml2 Nov 2008 04:50:40 -   1.1
+++ versions.xml5 Apr 2009 04:52:29 -
@@ -4,166 +4,166 @@
   Do NOT translate this file
 -->
 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
- 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
+ 
 
 
 

[PHP-DOC] ncurses documentation

[Keito Uchiyama]

Hi,

I'd like to work on the ncurses documentation, since it's almost 
non-existent and rather a confusing extension to use without help, but 
does its status as an experimental extension mean the effort might not 
be worth it?


Thanks,

Keito Uchiyama