Re: For the Love of God, Please Write Better Docs!

2016-08-06 Thread poliklosio via Digitalmars-d
On Friday, 5 August 2016 at 21:01:28 UTC, H.Loom wrote: On Friday, 5 August 2016 at 19:52:19 UTC, poliklosio wrote: On Tuesday, 2 August 2016 at 20:26:06 UTC, Jack Stouffer wrote: (...) (...) In my opinion open source community massively underestimates the importance of high-level examples,

Re: For the Love of God, Please Write Better Docs!

2016-08-05 Thread H.Loom via Digitalmars-d
On Friday, 5 August 2016 at 19:52:19 UTC, poliklosio wrote: On Tuesday, 2 August 2016 at 20:26:06 UTC, Jack Stouffer wrote: (...) I cannot agree more with that. In my opinion open source community massively underestimates the importance of high-level examples, articles and tutorials. To

Re: For the Love of God, Please Write Better Docs!

2016-08-05 Thread poliklosio via Digitalmars-d
On Tuesday, 2 August 2016 at 20:26:06 UTC, Jack Stouffer wrote: (...) I cannot agree more with that. In my opinion open source community massively underestimates the importance of high-level examples, articles and tutorials. To most library authors (judging from projects I've seen) source

Re: For the Love of God, Please Write Better Docs!

2016-08-04 Thread profan via Digitalmars-d
On Tuesday, 2 August 2016 at 20:26:06 UTC, Jack Stouffer wrote: 6. Examples for every function. Simple examples are nice, but an example which shows real world use is even better. You need to show the user why this function exists. 7. Module level examples, meaning examples which show the

Re: For the Love of God, Please Write Better Docs!

2016-08-02 Thread Adam D. Ruppe via Digitalmars-d
On Tuesday, 2 August 2016 at 20:26:06 UTC, Jack Stouffer wrote: libasync has no online docs, which makes the thing DOA for me. libasync is actually the one third party package I slapped on dpldocs.info: http://dpldocs.info/experimental-docs/libasync.html It is pretty minimal though, there

For the Love of God, Please Write Better Docs!

2016-08-02 Thread Jack Stouffer via Digitalmars-d
Warning, rant ahead. I was trying to replicate asyncio Python functionality in D for a script that needs some updating at work. I got inspired after attending many talks and demos on the subject of async network requests and disk IO at the PyOhio conference this past weekend. I wanted to see