Ivan Kozik
b1e1fababb
Fix precision note in the "Operators" reference page ( #5243 )
2016-09-22 15:42:03 +02:00
Eksperimental
1f604a9171
Fix a typo in the "Operators" page of the docs ( #5242 )
2016-09-22 10:25:20 +02:00
Frédéric Boyer
43f1721485
Clarify some of the subtleties linked to term ordering in the docs ( #5238 )
2016-09-21 23:07:01 +02:00
Steven Blowers
2a73cba378
Fixing spelling mistakes of specially -> especially. ( #5235 )
2016-09-21 10:27:34 +02:00
Andrea Leopardi
84caccabe1
Add a section about comparison operators in the "Operators" page ( #5230 )
2016-09-20 13:02:35 +02:00
Aaron Jensen
b473cfeeca
Fix struct built-in type documentation ( #5219 )
2016-09-15 10:19:01 +02:00
Tai An Su
9ed66c9d7c
Fix operators table ( #5207 )
2016-09-11 18:09:22 +02:00
Gabriel Taylor-Russ
9dcf58979e
Grammatical improvements to the "Writing Documentation" page ( #5180 )
2016-09-02 18:09:47 +02:00
Andrea Leopardi
3bb90f325e
Add a "Guards" page to the docs ( #5167 )
2016-08-27 22:51:47 +02:00
Andrea Leopardi
0acfee6a19
Add a page in the docs about operators ( #5142 )
2016-08-19 00:36:37 +02:00
Aleksei Magusev
05298aad63
Update doc for built-in types
...
* parameterized modules has gone in https://github.com/erlang/otp/commit/6b2b36f3ef1a6715b971b81c03edf534a64c6c55
* mfa() should use module() type
2016-08-12 21:28:56 +02:00
Eugene Pirogov
d280036cbd
Remove typo ( #5012 )
2016-07-15 15:01:55 +02:00
Eugene Pirogov
bc6a464649
Fix a typo in the "Typespecs" page in the docs ( #5011 )
2016-07-15 14:50:26 +02:00
Michał Muskała
eef3ef4910
Clarify optional callbacks documentation ( #5000 )
2016-07-13 11:10:21 +02:00
Eksperimental
207bbdb683
Typespec.md: spell it "two-element tuple" ( #4988 )
...
That's the way we do it across the project.
2016-07-10 12:07:35 +02:00
Andrea Leopardi
a06e9b7b6c
Add a "Behaviours" page to the documentation ( #4782 )
2016-06-06 17:54:04 +02:00
Andrea Leopardi
4852493a7a
Clean up the "Typespecs" page in the documentation
...
[ci skip]
2016-06-05 17:12:32 +02:00
eksperimental
0b8ae03d4d
Convert hex literals to uppercase ( #4748 )
2016-06-01 22:40:19 +02:00
eksperimental
7dcfcae7e2
Correct typespec group names ( #4706 )
2016-05-28 10:01:00 +02:00
Eric Meadows-Jönsson
bb88323027
Add support for OTP 19 map typespecs
...
* %{required(foo) => bar} and %{optional(foo) => bar} forms are added
* %{foo => bar} is deprecated in favor of the above forms
* %{...} is added to mean any map
* %{} now means empty map
2016-05-24 23:38:44 +02:00
Eric Meadows-Jönsson
61690b703d
Fix binary typespecs
...
* Removes <<_::size*unit>>
* Adds <<_::size, _::_*unit>>
2016-05-23 14:39:20 +02:00
eksperimental
2ab4846c2c
Minor corrections to Writing Documentation
2016-05-17 23:19:31 +07:00
José Valim
4196752435
Tidy up paragraph and move from appear to listed
2016-05-17 16:18:00 +02:00
Xavier Noria
d80c85a130
Reword the section about hiding docs in "Writing Documentation" ( #4634 )
...
[ci skip]
2016-05-17 15:16:35 +02:00
Xavier Noria
58cad80c9a
minor fixes in "Writing Documentation" [ci skip] ( #4632 )
2016-05-16 18:58:01 +02:00
eksperimental
16c08f0f4b
Fall-back functions: Kernel.to_char_list/1 and List.Chars.to_char_list/1 protocol
2016-05-09 00:35:44 +07:00
eksperimental
c3d28f76f2
Replace 'char_list' and 'char list' with 'charlist'
2016-05-07 03:20:57 +07:00
Myron Marston
a4c451449b
Use consistent spacing in code snippet. ( #4547 )
...
2 spaces instead of 1.
2016-04-22 20:59:33 +02:00
Eric Meadows-Jönsson
52b18d492e
Move named arguments paragraph
2016-04-20 21:34:14 +02:00
Myron Marston
77f7ba334c
Update Typespecs doc page to mention argument/element naming.
...
As far as I can tell, this is not documented anywhere.
2016-04-20 12:23:00 -07:00
Andrea Leopardi
a4437a2505
Add the keyword/0 and keyword/1 built-in types
2016-03-17 23:57:30 +01:00
José Valim
0709aff0ea
Update docs and CHANGELOG
2016-03-17 13:31:36 +01:00
Stephen Moloney
08ed49798a
bullet point - documenting functions with multiple clauses.
2016-03-17 18:43:34 +07:00
José Valim
d6c6db8073
Merge pull request #4375 from eksperimental/key_value_pairs
...
Use "key-value pairs" instead of "key-values"
2016-03-10 16:47:30 +01:00
José Valim
4876ede073
Improve sections on writing documentation
2016-03-10 09:46:37 +01:00
eksperimental
e57db09c15
Use "key-value pairs" instead of "key-values"
...
As suggested in changes recently introduced in https://github.com/elixir-lang/elixir/pull/4362
2016-03-10 02:07:37 +07:00
jisaacstone
11cf733ef2
Added a note about dialyzer not using map pair type information
...
See a similar note in the [Erlang reference
manual](http://erlang.org/doc/reference_manual/typespec.html#id77939 )
and [Björn-Egil's answer on the erlang-questions mailing
list](http://erlang.org/pipermail/erlang-questions/2016-March/088139.html )
2016-03-05 14:51:44 -08:00
José Valim
bcd7274a16
Fix typespecs table
2016-02-16 19:42:57 +01:00
eksperimental
7f774b7092
Typespecs.md: fix backticks in iolist
...
and place iolist() before iodata() since iodata refers to iolist
2016-02-09 07:32:21 +07:00
Aleksei Magusev
734dc0386e
Document identifier() type in Typespecs.md
2016-02-08 00:21:52 +01:00
José Valim
9ebdabbbff
Remove more imperative cases and related test cases
2016-02-07 12:31:18 +01:00
José Valim
b94eaa8547
Add document about scoping rules
2016-02-04 10:49:38 +01:00
José Valim
234a483c01
Update Naming Conventions.md
2016-01-31 09:52:02 +01:00
José Valim
e9959f1f05
Improve writing docs
2016-01-31 09:42:37 +01:00
Henrik Nyh
668932c57e
Naming Conventions doc: typo, commas
2016-01-03 12:21:29 +01:00
Myron Marston
4eb4d33dc3
abbreviations -> acronyms
...
Using all capitals is recommended only when you have an acronym
like HTTP, IO, SCM, etc. For an abbreviation like "Misc" or "Utils"
all caps should not be used.
2016-01-02 20:41:37 -08:00
José Valim
5cee89d511
Merge pull request #4142 from henrik/patch-10
...
Naming Conventions doc: function name typos
2016-01-02 20:01:36 +01:00
José Valim
a4b0d97155
Fixes to docs
2016-01-02 19:58:44 +01:00
Henrik Nyh
0d5dde61d6
Naming Conventions doc: function name typos
2016-01-02 19:58:37 +01:00
José Valim
29fcf5a9e4
Fix grammar
2016-01-02 19:26:31 +01:00