Commit Graph
399 Commits
Author SHA1 Message Date
Jean Klingler 24efbdfb7c Document whitespace rules for keyword syntax (#12773) 2023-07-08 17:24:01 +09:00
Lucas Francisco da Matta Vegi 36e71050cb Remaining macro-anti-patterns (Anti-pattern documentation) (#12769) 2023-07-08 10:17:30 +02:00
Iztok Fister Jr e374882c03 Revise the description of DSLs (#12762) 2023-07-06 21:50:27 +02:00
José Valim 999ecf73de Fix references in getting started guides 2023-07-06 16:08:36 +02:00
José Valim 1cd7e53875 Tidy up getting started guides conclusion 2023-07-06 16:07:30 +02:00
José Valim e55472e9b8 More guides 2023-07-06 15:49:05 +02:00
José Valim f7fcc160b8 More guides 2023-07-06 15:23:03 +02:00
José Valim 365cd44b1c More guides 2023-07-06 15:01:45 +02:00
José Valim 3a706f7a1a More guides 2023-07-06 13:54:36 +02:00
Lucas Francisco da Matta Vegi 1b33e7259e "Scattered process interfaces" (Anti-pattern documentation) (#12759) 2023-07-06 09:06:55 +02:00
Andrea LeopardiandJosé Valim 3c0efc1e2a Add "Comments" anti-pattern to the guides (#12758)
Co-authored-by: José Valim <jose.valim@dashbit.co>
2023-07-05 20:37:12 +02:00
José Valim 970691db2d More guides 2023-07-05 19:15:16 +02:00
José Valim 5547e35ffb More guides 2023-07-05 18:45:09 +02:00
José Valim e9e6f23105 Fixes to anti-patterns 2023-07-05 18:24:13 +02:00
José Valim 2a97e7e0fb Initial getting started version 2023-07-05 18:24:04 +02:00
Andrea Leopardi e8409fe8fb Polish some anti-patterns in the guides 2023-07-05 10:54:03 +02:00
Andrea Leopardi 4a9c11def4 Use <h4> titles in anti-patterns guides 2023-07-05 10:42:09 +02:00
Andrea Leopardi a446fcc95c Clean up some process-related anti-patterns 2023-07-05 09:34:22 +02:00
Andrea Leopardi 8e31412bae De-indent anti-pattern guides (#12755) 2023-07-05 09:25:11 +02:00
José Valim 9bdbcbb7f9 Move meta-programming to the bottom 2023-07-05 09:23:14 +02:00
José Valim 189dbcec67 use instead of import + nutrition facts (anti-patterns) 2023-07-05 09:13:42 +02:00
Andrea Leopardi e785d86095 Move meta-programming guide here from elixir-lang.org (#12750) 2023-07-05 08:54:47 +02:00
José Valim d0d80aee53 Apply changes and additional remarks to anti-pattern 2023-07-05 08:45:10 +02:00
Lucas Francisco da Matta Vegi e27dd766ba "Code organization by process" and "Unsupervised processes" (Anti-pattern documentation) (#12754) 2023-07-05 08:27:01 +02:00
Lucas Francisco da Matta Vegi 0d76145e1b Add "Working with invalid data" (Anti-pattern documentation) (#12753) 2023-07-04 21:06:38 +02:00
José Valim 51830c13a1 Provide structure for anti-patterns (#12748) 2023-07-04 20:40:00 +02:00
José Valim 4895540a32 Consistent casing in titles 2023-07-04 19:06:18 +02:00
José Valim 6909684d6b Create a new references section in the sidebar 2023-07-03 20:47:27 +02:00
Benjamin Milde 11cfb574c7 Generalize description of multiple matching variables in the same pattern (#12722) 2023-06-27 15:03:38 +02:00
José Valim edc2326130 Start v1.16-dev 2023-06-03 20:27:23 +02:00
José Valim 3b77086073 Define "nutrition facts" for "use SomeModule" (#12613)
One common concern about using Elixir libraries
is that "use SomeModule" does not make clear how
it impacts the caller. Most of the time those
changes are minor but it is impossible to know
without traversing the source code.

This pull request suggests defining a summary
alongside each module that succintly explains
the impact of using it.

This is documented as best practice in our guides
and we added the note to all of Elixir modules.
2023-05-29 09:33:21 +02:00
Nathan Long 684130d007 Note about typespecs for functions which raise (#12568)
* Note about typespecs for functions which raise

'no_return' was removed from functions like `File.copy!/3` in
https://github.com/elixir-lang/elixir/pull/8092

In the comment thread, someone asked whether the documentation should
mention that certain other functions may raise, but José responded:

> Any function can fail any time in face of invalid input

* Incorporate PR feedback
2023-05-18 23:36:42 +09:00
Rodolfo Carvalho ebd9ab3a13 Fix typo in naming-conventions.md (#12517) 2023-04-10 10:31:39 +02:00
Nathan Long 9024b1813d Examples of composing a keyword list type (#12482)
Examples by Myron Marston and Michał Muskała in
https://elixirforum.com/t/typespecs-best-way-to-spec-keyword-lists/2991
2023-03-22 14:48:49 +01:00
José Valim a107d6d0f5 Update sigil docs 2023-03-05 20:20:56 +01:00
José Valim 2bf92f1530 More improvements to docs 2023-02-19 11:20:15 +01:00
José Valim 2dd9f3a2f1 Better update and cross-link references
Closes #12419.
2023-02-19 11:04:43 +01:00
Nick Bugaiov 79f717d813 writing-documentation: removed redundant link (#12308)
Removed a link that points the second time to the same markdown documentation
2022-12-21 22:00:02 +01:00
sabiwara 4b5097ca6d Add :on_undefined_variable compiler option (#12279) 2022-12-03 18:41:41 +01:00
George Rodrigues 89d831d67e fix: typos on test and docs (#12167) 2022-10-04 14:53:09 +02:00
José Valim fb1ce86b2e Review Unicode documents according to Unicode 15
Closes #12142.
2022-09-17 17:46:50 +02:00
Michael Adkins 4dd730267a Add commas to bare usage of "however" where appropriate (#12119) 2022-09-06 20:29:01 +02:00
Dimitar Panayotov d43b1b8c12 Add missing word in docs (#12111) 2022-09-02 23:38:18 +02:00
Nathan Long 2c4c102b29 Show usage of @typedoc and @doc for structs (#12037)
* Show usage of @typedoc

* Show adding '@doc' above a 'defstruct'
2022-08-02 19:06:41 +02:00
José Valim bc0093d943 Fix deprecation table rendering, closes #12034 2022-08-01 12:06:06 +02:00
Andrea Leopardi 9a81eb8bdd Add nonempty_binary/0 and nonempty_bitstring/0 (#12022) 2022-07-28 09:30:04 +02:00
José Valim 76a683f41c Add deprecations 2022-07-27 17:18:53 +02:00
José Valim 239f8f9e3b Require Erlang/OTP 24 2022-07-27 13:20:42 +02:00
José Valim fbf4b1f3c9 Start v1.15.0-dev 2022-07-27 12:54:37 +02:00
Victor Rodrigues 3d02f27f29 Add documentation about using guards for map fields (#11913) 2022-06-09 13:43:53 +01:00