Commit Graph
35 Commits
Author SHA1 Message Date
José Valim 0a1a5991d9 Remove unecessary parens in nullary type funs 2022-10-14 13:55:23 +02:00
José Valim 239f8f9e3b Require Erlang/OTP 24 2022-07-27 13:20:42 +02:00
Łukasz Samson 0a8b03f397 Add Node.spawn_link (#11540) 2022-01-05 12:11:04 +01:00
Wojtek Mach 934f9b7351 Fix links (#9882) 2020-03-09 10:06:00 +01:00
Hassan Shaikley e13571e6db Improve Node.start/3 documentation (#9272) 2019-08-08 10:07:53 +02:00
Tobiasz Małecki a3d7c1928e Added missing specs for Node get_cookie/0 and set_cookie/2 (#8719) 2019-01-26 17:22:04 +01:00
eksperimental bd9f6268fe Mention in the docs every function inlined by the compiler
elixir_rewrite.erl has been audited, function by function:
- All missing "Inlined by the compiler." lines have been added.
- Standardize sentence avoid mentioning the function its inline to (System module).
- "Inline by the compiler." goes always before ##Options or ##Examples
2018-04-26 18:58:07 +08:00
Seivan Heidari 41dc61b2c3 State argument on Node should be documented (#7089) 2017-12-06 13:00:50 +01:00
José Valim 06347dba1e Format more low hanging fruit files 2017-10-10 18:09:59 +02:00
José Valim 0feb71e47d Remove links from Erlang functions and instead let tools do it
Also remove reference to the port drivers functionality.
2017-07-15 11:34:55 +02:00
Michał Muskała 28f1e60783 Refer to :net_kernel.monitor_node from Node.monitor (#5814) 2017-02-24 11:31:46 +01:00
Sonny Scroggin 6eb6e57888 Correct docs for Node.connect/1 (#5390) 2016-10-31 20:54:54 +01:00
Eksperimental 9257fd83c1 Properly spell PID (#4883) 2016-06-25 09:03:35 +02:00
José Valim 979a20cc16 Merge pull request #3691 from eksperimental/erlang_function_urls
Add text to all links
2015-09-08 19:00:51 +02:00
eksperimental 766a863041 Add text to all links
This commits covers 100% of all links in the documentation,
using a words to describe what the page is about.

It users the `:module.function/arity` format for erlang functions that
link to the earlang docs.

I also changed some of the sentnces using the link from
- See [:erlang.function/2](http://...) for a list of available options.

to
- For a list of available options, see [:erlang.function/2](http://...)

The reasoning behind is that I think it's better to have an link at the end of the sentence
and not in the middle, so the reades doesn't need to finish the sentence to know what is it about and go back
and find the link. This way all the information is given before the link, so the users stops reading and can
click directly.
2015-09-08 23:16:14 +07:00
eksperimental ee79861049 Add arity or correct it for functions that are not being linked in the html docs
original issue: https://github.com/elixir-lang/ex_doc/issues/321

I created a shell script that checks for anything references to Modules that are not actually linked
http://git.io/check_not_linked_exdoc.sh

You can see the output here:
https://gist.github.com/eksperimental/6dc9bce36710a3c8b1d9

I will update the script to work with regular elixir projects, so it can be used by other projects
2015-09-08 01:47:15 +07:00
eksperimental eaad9cc687 standardize erlang.org/doc links to use www 2015-07-14 02:02:06 +07:00
James Fish 27ec4a9770 Fix elixir dialyzer warnings 2014-09-03 19:29:01 +01:00
José Valim 38aa5c57e5 Add Node.start/3 and Node.stop/0, closes #2406 2014-06-17 16:56:50 +02:00
José Valim 095e4a7d2e Improve docs for string, process and supervisor 2014-05-16 22:28:20 +02:00
José Valim a52bbfce8e Update Node docs and CHANGELOG 2014-03-13 08:00:11 -07:00
paladiy 6696184fc9 add ping method to Node module
Signed-off-by: José Valim <jose.valim@plataformatec.com.br>
2014-03-13 07:48:10 -07:00
José Valim fe2e4a1010 Move from // to \\ 2014-01-28 10:50:00 +01:00
José Valim 24da600a72 Document inlined functions are BIFs 2014-01-24 11:37:43 +01:00
José Valim fe8fc1be25 Inline some process and node calls, closes #1808 2014-01-22 15:06:35 +01:00
John Warwick 22336a94d0 Fixed doc typos in String and Node 2013-08-23 10:58:38 -04:00
José Valim 90093bd4e2 Support --cookie, --hidden, Node.get_cookie and Node.set_cookie, closes #910 2013-05-05 12:34:15 -06:00
José Valim 5fe1544ff3 Deprecate Process.self in favor of Kernel.self to make imports easier, closes #832 2013-02-09 12:10:15 -07:00
ILYA Khlopotov ddc9733cf2 Add Node.connect/1 method 2013-02-04 12:34:11 -08:00
ILYA Khlopotov 9bcc4be3f5 Fix typo in typespec of Node.disconnect 2013-02-04 12:32:29 -08:00
Yurii Rashkovskii f38b0b8427 Add type specifications to the Node module 2012-12-28 23:30:35 -08:00
José Valim 85fce7aaef Fix delegations in Node.ex (ht @yrashk) 2012-10-27 11:15:56 +02:00
José Valim 9aba2c1260 Move some functions from Process to Node module 2012-07-29 14:13:41 +02:00
José Valim fea9455eb7 Add self() back since it is allowed in guard clauses 2012-07-17 13:49:34 +02:00
José Valim d5031b6347 Move all code to erlang style apps 2012-07-05 20:20:16 +02:00