Input/Output about haxemanual HOT 5 OPEN

What is needed for this issue to be resolved?

from haxemanual.

What is needed for this issue to be resolved?

from haxemanual.

Well, documentation of the haxe.io package and how to use it. Output, Input, FileInput, StringInput, BytesInput... that kind of stuff.

from haxemanual.

Bytes is important seems that name is not familiar with people mastering POSIX/C terminology and there is considerable implementation there and no description. Also *Data types that seems to represent native objects - and for those the API should be very explicit even listing which native type is used on each platform since users micro optimizing at some point will have to cast them

Use a language in terms of POSIX or C since that is the common language on most platforms.

haxe.io types are poorly documented. None of them has a description and only few members are documented. This is huge blocker for new people since:

• Some types, like Bytes* have names that are unknown in POSIX and in general developers form other platforms are lost
• IO types needs to be clearly understood in order to optimally implement IO which is critical
• the only workaround is to read the haxe.io package source code it self in order to figure out, more or less, what these types do or optimal performance implementations when

I strongly recommend to mention posix names if there is a straight forward relation ship and other language types and not just mention "words like " native" or "array" or "int", for example, "BytesData represents a native array of bytes which in general are stored as 8 bit unsigned integers, (integers in 0-255). Each target uses the optimal and minimal implementation, and if supported an ArrayBuffer view to avoid referencing the whole array. for example in C++ an unsigned short[] , in JavaScript an ArrayBuffer in python python.ArrayBuffer, "

Although this might seems exposing private code, users need to clearly understand exactly what the type represents, at least in terms of POSIX or C in order to implement optimal solutions need

My point, don't be high level here. (this is a feedback for the API not for the manual which it should by more high level, but since it seems the initiative is happening here...) thanks

from haxemanual.

Well, documentation of the haxe.io package and how to use it. Output, Input, FileInput, StringInput, BytesInput... that kind of stuff.

This section also includes the sys.io functions right? I can write some sections about command line input/process spawn etc

from haxemanual.