Commit Graph
60 Commits
Author SHA1 Message Date
Theodor Fiedler d884cbc3ca Fix random typos (#13540) 2024-05-06 11:55:48 +02:00
José Valim 80a20d20bb More improvements to module attributes guides 2024-05-02 10:29:20 +02:00
José Valim 00818b6045 More clarifications to module attributes as constants 2024-05-02 01:17:16 +02:00
José Valim 813c5aaba2 Update docs for module attributes
It is not necessary to push module attributes as a mechanism
for constants. In fact, regular functions are a better default
for constants in the majority of the cases.
2024-04-27 21:52:09 +02:00
Nathan Long 388b69ee7a Expand description of how catch works (#13501) 2024-04-20 22:01:17 +02:00
wiehann 6138838ff8 Fix sentence in basic-types documentation (#13450) 2024-03-28 19:43:39 +01:00
June Kelly 2d38526bde Fix typo: remove stray '_' from front of 'unexpected' (#13403) 2024-03-09 20:49:02 +01:00
José Valim 966a73532a Consistent use of the word guide in docs 2024-03-06 20:57:45 +01:00
José Valim dd13c508e8 Add mix test --breakpoints 2024-02-29 14:48:54 +01:00
Artem Solomatin d9005ebdca Add example and update links in debugging doc (#13376) 2024-02-29 00:23:43 +01:00
José Valim 9dcdc1a5b2 Add get_in/1 with safe nil-handling for access and structs (#13370) 2024-02-27 08:04:36 +01:00
Cameron Duley c1b54c6125 Add callout to full bitstring reference in the getting started guide (#13360) 2024-02-22 08:51:34 +01:00
Steve Johns 5e13403068 Add explicit clarification that values like 0 and "" are truthy in Elixir (#13300) 2024-01-30 09:57:29 +01:00
Steve Johns 810140b86b Fix string interpolation example in basic-types.md (#13292) 2024-01-28 18:07:38 +01:00
José Valim 5c45ea6fed Fix docs link
Related to #13284.
2024-01-27 11:46:21 +01:00
Jean KlinglerandJosé Valim a75371ad18 Make c/e/fprof clickable links in doc (#13290)
* Make c/e/fprof clickable links in doc

* Update lib/elixir/pages/getting-started/debugging.md

Co-authored-by: José Valim <jose.valim@gmail.com>

* Fix links

---------

Co-authored-by: José Valim <jose.valim@gmail.com>
2024-01-27 18:00:05 +09:00
Michał Łępicki b66c7c0e74 Improve wording in iex -S mix test --trace doc (#13272)
avoid -> prevents
2024-01-21 13:35:32 +01:00
José Valim 97caaa56ab More docs to debug projects 2024-01-21 09:18:27 +01:00
Jean Klingler 8cde231bbd behaviour -> behavior when not about OTP behaviours (#13240) 2024-01-09 15:25:14 +09:00
Will DouglasandWill Douglas 16ca292659 Fix typo in docs: for -> force (#13215)
Co-authored-by: Will Douglas <will.cavalcanti@vmtecnologia.io>
2023-12-29 15:55:16 +01:00
José Valim aa65d0625c Update anonymous-functions.md 2023-12-13 04:20:45 +01:00
José Valim ef2ccfc7db Update anonymous-functions.md 2023-12-13 04:19:05 +01:00
Logan Hasson 2e0a1fe186 Update arity of String.split (#13151)
`String.split/2` is mentioned, but `String.split/1` is actually used in the example.
2023-12-01 08:22:22 +09:00
Stevo-S 47fcb5f902 Fix a broken link to the "Guards" section (#13112)
of the "Patterns and Guards" references page.
The link is from the "Case, Cond and If" getting-started page.
2023-11-15 22:41:45 +01:00
Artem Solomatin dbde3ba78e Fix links references (#13099) 2023-11-12 10:07:12 +01:00
Minh Daoandminhqdao bd51ca7bd8 Fix typo in getting-started guide (#13085)
Co-authored-by: minhqdao <hello@minhdao.de>
2023-11-07 22:51:35 +01:00
Erik André Jakobsen 298bf7e7e5 [docs] Clean up sigils intro (#13077) 2023-11-06 13:27:14 +01:00
Tony Dang 076d1e2056 Fix typo in "Getting Started - Enumerables and Streams" docs (#13073) 2023-11-04 08:59:00 +01:00
Ioannis Kyriazis 113dba376c is -> us (#13072) 2023-11-03 23:23:45 +01:00
José Valim ad7c73244d Clarify best practices and update anti-patterns list 2023-10-30 15:12:28 +01:00
José Valim a32ce8b252 Provide more rationale on do-end 2023-10-29 08:41:15 +01:00
samanera 2f9061e8e0 Fix typos in elixir/pages/ (#13022)
`is an a float` → `is a float`
`valuesare`     → `values are`
`specificatio`  → `specification`
2023-10-20 06:25:12 +02:00
José Valim c7d2c37565 Update sigil_r example 2023-10-13 11:23:34 +02:00
José Valim f9cca8fd13 Remove duplicate sigil docs now that guides are included 2023-10-04 09:56:50 +02:00
Stevo-S e4431b8589 Clarify Any Protocol implementation derivation (#12978)
A small edit on the "Deriving" section of the "Protocols" chapter in "Getting Started".

Changing "we should be fine with the implementation of Any" to
"should we be fine with the implementation of any" hopefully
better communicates that we can use the Any implementation of
the protocol if we wish to but not that we have to.
2023-10-02 14:44:23 +02:00
Jean Klingler 8e6c898fca Remove duplicate word in guide (#12936) 2023-09-16 16:55:53 +09:00
chengshq f5a9a65c42 Fix index on split (#12915) 2023-09-08 13:44:55 -04:00
José Valim 29b29c5fbf Add an introduction to module names 2023-09-07 05:46:52 -04:00
José Valim 379f38e64e Add Enum cheatsheet 2023-08-21 13:16:59 +02:00
Jean Klingler 3f930b4a92 Update other undefined variable errors in docs (#12876) 2023-08-20 15:17:49 +09:00
José Valim b87b0a6e86 Fixes to guides and diagrams 2023-08-19 12:06:54 +02:00
José Valim cb3725234b More fixes, add disclaimer 2023-08-18 00:58:02 +02:00
José Valim 52158d7de3 More docs for maps/keywords 2023-08-14 12:58:44 +02:00
José Valim ec2733611b Add :observer.start at the end 2023-08-14 12:43:00 +02:00
José Valim 63fc8b6b9e Improve lists and tuples guides with more and simpler examples 2023-08-12 23:04:30 +02:00
magashpillay 284f0b2501 Fix code block in Markdown guides (#12852) 2023-08-10 10:40:56 +02:00
magashpillay dced276114 Update binaries-strings-and-charlists.md (#12850) 2023-08-09 10:22:05 +02:00
Artem Solomatin a6439f42ef Fix typo (#12835) 2023-08-04 18:07:38 +02:00
Florent Guilleux a1112fe895 Explain why functions returns extra information with tuples (#12824)
Currently the guide says

> One very common use case for tuples is to use them to return extra information from a function.

but I find it does not explicitly say why.
2023-07-28 09:05:52 +02:00
Andrea Leopardi 32cd48b398 Lint Markdown guides (#12775) 2023-07-10 11:45:01 +02:00