File tree Expand file tree Collapse file tree 1 file changed +10
-0
lines changed
Expand file tree Collapse file tree 1 file changed +10
-0
lines changed Original file line number Diff line number Diff line change @@ -615,13 +615,23 @@ Translations of the guide are available in the following languages:
615615 then a note describing the problem.
616616 <sup >[[ link] ( #annotation-keyword )] </sup >
617617
618+ ``` elixir
619+ # TODO: Deprecate in v1.5.
620+ def some_function (arg), do: {:ok , arg}
621+ ```
622+
618623* <a name =" exceptions-to-annotations " ></a >
619624 In cases where the problem is so obvious that any documentation would be
620625 redundant, annotations may be left at the end of the offending line with no
621626 note.
622627 This usage should be the exception and not the rule.
623628 <sup >[[ link] ( #exceptions-to-annotations )] </sup >
624629
630+ ``` elixir
631+ start_task ()
632+ Process .sleep (5000 ) # FIXME
633+ ```
634+
625635* <a name =" todo-notes " ></a >
626636 Use ` TODO ` to note missing features or functionality that should be added at a
627637 later date.
You can’t perform that action at this time.
0 commit comments