Documentation Improvement Initiative

[H. S. Teoh]

On Mon, Feb 17, 2020 at 12:16:26PM +0000, Mike Parker via Digitalmars-d wrote:
[...]
> This thread is a place to collect your documentation pain in one
> place. I'm about to publish a blog post announcing this (a few minutes
> after I hit 'Send' on this post):
> 
> http://dlang.org/blog/2020/02/17/news-update-swag…on-help-and-more/
> 
> As I mention there, we need you to be as specific as you can. What,
> specifically, is missing? What is unclear? What is incorrect? Give as
> much detail as you can. We want to be able to gather this info and
> define specific documentation tasks that anyone can step in and
> complete with the information provided.
[...]

std.windows.registry does not have any docs.  The website doesn't even
have a link for it! (And going to the page by editing the URL manually
brings up a page with no docs for any symbol.)

Note that the code itself *does* have docs; the problem is that the
website docs are generated on Posix but all symbols in this module are
under version(Windows).  We seriously need to generate docs for *all*
platforms, not just the one being used to generate them!

(The other std.windows.* modules have the version(StdDoc) hack, but
that's seriously b0rken because what's used to generate docs is
different from what actually compiles, meaning any mistakes will not be
caught by CI, code examples are not compile-checked, etc..)


T

-- 
People tell me that I'm skeptical, but I don't believe them.