Bug 9469 – Keywords list could use linkage; more-humane documentation
Status
RESOLVED
Resolution
FIXED
Severity
enhancement
Priority
P2
Component
dlang.org
Product
D
Version
D2
Platform
All
OS
All
Creation time
2013-02-07T03:34:00Z
Last change time
2014-11-13T00:08:38Z
Assigned to
nobody
Creator
wyatt.epp
Comments
Comment #0 by wyatt.epp — 2013-02-07T03:34:38Z
The list at http://dlang.org/lex.html#Keyword is long and flat. It would be well-served by linking to relevant documentation entries for each keyword in cases where that exists. (Things like interface, mixin, pragma, scope, et al). The goal is to make navigating the documentation less error-prone for newcomers.
As an additional consideration, it would be nice if each item in that list had (at least) a short, single sentence, description. Keywords with zero context often fail to indicate what they interact with, which impedes language acquisition. (e.g. it simplifies questions like "What does 'synchronized' even do?").
To some extent, I feel the keywords deserve their own page. (In-addition-to if not instead-of a flat list on the lexical page.) Simply finding the list is more difficult than it needs to be, as there are no top-level anchors for the Lexical page and the keyword anchor is simply mixed in with the list of tokens. Going this direction, it would probably be helpful to also arrange them according to their documentation section for reinforcement.