elephant.io icon indicating copy to clipboard operation
elephant.io copied to clipboard

Speaking about the docs

Open Nek- opened this issue 9 years ago • 2 comments

Hey,

Got some questions about the docs. You already told me there's no doc. (Actually there's no real test either) https://twitter.com/talus_/status/598149855912009728

BTW too bad there is no documentation. I'm ok to write some parts of the doc. The point is, should I create a PR here or you planned to create a new project for that ? What should be the format ? (markdown ?)

Nek- avatar May 12 '15 16:05 Nek-

I can help to write docs.

Why not write correctly the phpdoc and generate documentation ?

vincentdieltiens avatar May 12 '15 16:05 vincentdieltiens

The PHPDoc is correctly written AFAIK, just the "functionnal" doc which is missing. If you want to do it, go ahead (sadly, I do not have enough time to make it...) ! RST or Markdown should be fine.

As for the tests, the thing is, it depends too much on a real socket server, which Elephant does not really provide (except in the examples), and as it needs to open a real socket, it is a pain to test. If you have any idea, do tell !

Taluu avatar May 12 '15 17:05 Taluu