[erlang-questions] Questions about Erlang documentation

[Sean Hinde]

On 1 Nov 2006, at 21:23, 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?

This follows the UNIX convention of including the man page chapter in  
parentheses after the name. If you have downloaded and installed the  
erlang man pages tar you can do:

% erl -man gen_server

gen_server(3)              ERLANG MODULE DEFINITION               
gen_server(3)

MODULE
        gen_server - Generic Server Behaviour

DESCRIPTION
        A behaviour module for implementing the server of a client- 
server rela-
        tion. A generic server process (gen_server) implemented using  
this mod-
        ule  will  have a standard set of interface functions and  
include func-......


> And one more question: I occasionally find misprints in docs - Is  
> there any email where I should send information about them?

You could send them to erlang-bugs@REDACTED, where with luck and a  
following wind they will raise to the top of the priority list of  
someone at Ericsson.

BR,
Sean