[erlang-questions] Questions about Erlang documentation

Gunilla Arendt <>
Wed Nov 8 12:14:56 CET 2006


You've already got a number of replies, but I can add that the reason
for using the Unix man page convention "see xyz(3)" is mainly to avoid 
having to use longer (and IMO clumsier) constructions such as
"see the documentation for xyz" all the time. Also, by using "xyz(3)"
it should be clear that it is the *documentation* for xyz you should
look at, not the module itself.

Send the documentation bug reports to the erlang-bugs mailing list.

/ Gunilla, Erlang/OTP team

Kirill Zaborski wrote:
> Investigating Erlang official documents I see a moment which I do not 
> understand:
> In a lot of chapters I see something like "|gen_server(3)" |mentioned 
> (That's from 
> http://www.erlang.org/doc/doc-5.5.1/doc/design_principles/gen_server.html 
> ). The first thought was about functions and their arity, but that's not 
> a function of course. So what exactly is this?
> And one more question: I occasionally find misprints in docs - Is there 
> any email where I should send information about them?
> 
> BR,
> Kirill.




More information about the erlang-questions mailing list