Merge pull request #4142 from henrik/patch-10

Naming Conventions doc: function name typos
This commit is contained in:
José Valim
2016-01-02 20:01:36 +01:00
+2 -2
View File
@@ -67,11 +67,11 @@ The version without `!` is preferred when you want to handle different outcomes
However, if you expect the outcome to always to be successful (e.g. if you expect the file always to exist), the bang variation can be more convenient and will raise a more helpful error message (than a failed pattern match) on failure.
More examples of paired functions: `Base.decode_16/2` and `Base.decode_16!/2`, `File.cwd/0` and `File.cwd!/0`
More examples of paired functions: `Base.decode16/2` and `Base.decode16!/2`, `File.cwd/0` and `File.cwd!/0`
There are also some non-paired functions, with no non-bang variant. The bang still signifies that it will raise an exception on failure. Examples: `Mix.Config.validate!/1`, `Protocol.assert_protocol!/1`
In macro code, the bang on `Kernel.alias!/1` and `Kernel.var!/1` signifies that [macro hygiene](http://elixir-lang.org/getting-started/meta/macros.html#macros-hygiene) is set aside.
In macro code, the bang on `Kernel.alias!/1` and `Kernel.var!/2` signifies that [macro hygiene](http://elixir-lang.org/getting-started/meta/macros.html#macros-hygiene) is set aside.
## Trailing question mark (`foo?`)