Skip to content

Commit 5f1e5eb

Browse files
author
José Valim
committed
Update record docs style
1 parent 9312a7d commit 5f1e5eb

File tree

2 files changed

+7
-6
lines changed

2 files changed

+7
-6
lines changed

CHANGELOG.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* [Macro] Improve printing of the access protocol on `Macro.to_string/1`
1717
* [Macro] Add `Macro.to_string/2` to support annotations on the converted string
1818
* [Mix] Automatically recompile a project if the Elixir version changes
19-
* [Path] Add `Path.relative_to_cwd`
19+
* [Path] Add `Path.relative_to_cwd/2`
2020
* [Regex] Allow erlang `re` options when compiling Elixir regexes
2121
* [String] Add regex pattern support to `String.replace/3`
2222
* [String] Add `String.ljust/2`, `String.rjust/2`, `String.ljust/3` and `String.rjust/3`

CONTRIBUTING.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -119,12 +119,13 @@ For modules, records, protocols and types say what it is. For example write
119119
something like:
120120

121121
```elixir
122-
@doc """
123-
Information about a file.
122+
defrecord File.Stat, [...] do
123+
@moduledoc """
124+
Information about a file.
124125
125-
...
126-
"""
127-
defrecord File.Stat ...
126+
...
127+
"""
128+
end
128129
```
129130

130131
Keep in mind that the first paragraph might show up in a summary somewhere, long

0 commit comments

Comments
 (0)