[Issue 16103] New: DDOC module-level function list descriptions refer to unknown parameter names
digitalmars-d-bugs at puremagic.com
Mon May 30 12:25:33 PDT 2016
Issue ID: 16103
Summary: DDOC module-level function list descriptions refer to
unknown parameter names
Assignee: nobody at puremagic.com
Reporter: zorael at gmail.com
They make sense when you're reading the individual pages generated for the
functions themselves, but not so much in the lists on the module's page.
They're... specific, not generic enough.
Some cherry-picked examples:
Description: "Performs the binary operation 'op' on val using 'mod' as the
Description: "Stores 'writeThis' to the memory referenced by 'here' if the
value referenced by 'here' is equal to 'ifThis'. This operation is both
lock-free and atomic."
(...writeThis, here, ifThis?)
Description: "Starts fn(args) in a new logical thread."
Description: "Yields a value of type T to the caller of the currently executing
I don't know of any good solutions. The list is a good way to roughly outline
the functions in the module, but seeing the behaviour described in terms of
'type T' and 'fn(args)' is a trap for young players and only makes sense if you
already have an idea of how they work.
More information about the Digitalmars-d-bugs