609 reputation
1514
bio website mattischneider.fr
location France
age 25
visits member for 3 years, 7 months
seen Oct 14 '13 at 11:12

Eclectic engineer. Building software, studying humans, designing interactions, thinking society.


May
7
awarded  Yearling
Jan
24
awarded  Nice Answer
Jan
16
awarded  Popular Question
Jul
4
awarded  Famous Question
Jan
17
awarded  Good Question
Oct
12
awarded  Yearling
May
17
awarded  Notable Question
Feb
21
accepted How to document events?
Feb
21
awarded  Critic
Feb
21
comment How to document events?
The question was not about documenting who fires events, but what are the events. Plus, I disagree with the definition of code documentation you give (in this particular context): if I am an event listener, I don't give a damn about why am I here beyond the fact that the event source decided it was relevant. The only context I am in is the one that is passed to me. I don't want to know which methods fire which events, I want to know what methods do, and what events are available to me. When and how both are related is not my problem, it's the source's one.
Feb
21
awarded  Commentator
Feb
21
comment How to document events?
“secondary” was not meant in a derogative manner. I called it this way because it is not an interface as per the definition of an API: you don't call events, you listen to them. It is “secondary” as it belongs to a “second category” of interfaces. Whether you consider it primary or secondary in importance completely depends on the library coding style.
Feb
21
comment How to document events?
@jk. Of course. The question is not so much documentation for explaining the behavior as it is about documentation for discovery. Even if the events have extremely clear names, if you don't know they are fired, they are of little use.
Feb
21
asked How to document events?
Dec
28
awarded  Self-Learner
Dec
5
awarded  Popular Question
Nov
20
awarded  Nice Question
Oct
12
awarded  Yearling
Sep
15
awarded  Autobiographer
Jun
18
accepted Is BDD actually writable by non-programmers?