www.digitalmars.com         C & C++   DMDScript  

digitalmars.D.announce - Post: Why no one is using your D library

reply aberba <karabutaworld gmail.com> writes:
Why no one is using your D library

So I decided to write a little something special. Its my love 
letter to D folks.

https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
Jul 02
next sibling parent reply Patrick Schluter <Patrick.Schluter bbox.fr> writes:
On Thursday, 2 July 2020 at 14:56:09 UTC, aberba wrote:
 Why no one is using your D library

 So I decided to write a little something special. Its my love 
 letter to D folks.

 https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
Thank you. Really good and I hope devs here will follow your advices. It's needed.
Jul 02
parent jmh530 <john.michael.hall gmail.com> writes:
On Thursday, 2 July 2020 at 16:04:20 UTC, Patrick Schluter wrote:
 [snip]

 Thank you. Really good and I hope devs here will follow your 
 advices. It's needed.
Agreed.
Jul 02
prev sibling next sibling parent Paul Backus <snarwin gmail.com> writes:
On Thursday, 2 July 2020 at 14:56:09 UTC, aberba wrote:
 Why no one is using your D library

 So I decided to write a little something special. Its my love 
 letter to D folks.

 https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
Excellent article. As the author of a moderately-popular dub package, I'm convinced that one of the reasons it's succeeded where other similar packages haven't is that I've made high-quality documentation a priority. For anyone interested in learning more about how to write good documentation, I've found the guide at writethedocs.org to be a good resource: https://www.writethedocs.org/guide/
Jul 02
prev sibling next sibling parent reply claptrap <clap trap.com> writes:
On Thursday, 2 July 2020 at 14:56:09 UTC, aberba wrote:
 Why no one is using your D library

 So I decided to write a little something special. Its my love 
 letter to D folks.

 https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
i think one problem is a default docs generated by DMD are goddamn awful. They actually look better if you delete the CSS at the top and have no styling. So i looked ddox? and adrdoc? i think and they put everything onto its own page. Better styling but tons of pages to click through, and some weird formatting in places. There should a flexible simple solution in the box. What we seem to get is a shitty default, and two bespoke options. Even a good tutorial on how to coax something useful from DMD would help. So i've kind of given up of documentation atm.
Jul 02
parent reply Adam D. Ruppe <destructionator gmail.com> writes:
On Thursday, 2 July 2020 at 17:19:31 UTC, claptrap wrote:
 and adrdoc? i think and they put everything onto its own page.
Yeah, I find it is generally easier to read, search, and link this way. It does have an overview page for anything though you can skim through.
 Even a good tutorial on how to coax something useful from DMD 
 would help.
Not even worth trying imo, that's why i wrote a replacement from scratch. adrdox could prolly be modified to do all one page, or just load the pages and embed after the fact. just im not sure if it has value tbh
Jul 02
parent claptrap <clap trap.com> writes:
On Thursday, 2 July 2020 at 17:29:29 UTC, Adam D. Ruppe wrote:
 On Thursday, 2 July 2020 at 17:19:31 UTC, claptrap wrote:
 and adrdoc? i think and they put everything onto its own page.
Not even worth trying imo, that's why i wrote a replacement from scratch. adrdox could prolly be modified to do all one page, or just load the pages and embed after the fact. just im not sure if it has value tbh
Tbh i much prefer the navigation on dlang, a tree view on the left, and a single page per module, but vastly prefer your presentation. The whole thing on dlang with putting everything in its own rounded outline rectangle with a red bar at the left hand side is hideous. Anyway I realise its a personal preference thing, and dont mean to criticise adrdoc, it's a big improvement.
Jul 02
prev sibling next sibling parent 0xEAB <desisma heidel.beer> writes:
On Thursday, 2 July 2020 at 14:56:09 UTC, aberba wrote:
 Why no one is using your D library

 So I decided to write a little something special. Its my love 
 letter to D folks.

 https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
Nice article. Thumbs up!
Jul 02
prev sibling parent solidstate1991 <laszloszeremi outlook.com> writes:
On Thursday, 2 July 2020 at 14:56:09 UTC, aberba wrote:
 Why no one is using your D library

 So I decided to write a little something special. Its my love 
 letter to D folks.

 https://aberba.vercel.app/2020/why-no-one-is-using-your-d-library/
Thanks, I'll try to write better documentation for my packages, maybe even rename my "bindbc" stuff so Mike Parker won't get harassed for my own stuff (bindbc-zstandard and bindbc-jsl).
Jul 02