gaspersic/freeCodeCamp
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

fix typo (#28190)

Browse Source
This commit is contained in:
VeraCologne
2019-01-20 02:47:28 +01:00
committed by Tom
parent bae59e69bd
commit 548a0e7dde
1 changed files with 2 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
guide/english/elixir/documentation/index.md
View File

@ -3,7 +3,7 @@ title: Documentation
--- ---
## Documentation ## Documentation
One of the best advanced of Elixir in comparison to other programming languages is its documentation system. Elixir's documentation is created by your code comments and made into a pretty HTML Website for you to browse with ease and understand how the application works. Once you understand how to properly comment your code in Elixir, you'll be able to explain how your application works to other programmers with ease. In the examples below we show the usage of Elixir's documentation functions in a fictional webserver module. One of the best advantages of Elixir in comparison to other programming languages is its documentation system. Elixir's documentation is created by your code comments and made into a pretty HTML Website for you to browse with ease and understand how the application works. Once you understand how to properly comment your code in Elixir, you'll be able to explain how your application works to other programmers with ease. In the examples below we show the usage of Elixir's documentation functions in a fictional webserver module.
### Inline Documentation ### Inline Documentation
Inline documentation uses a `#` in front of text describing something about the code. Inline documentation uses a `#` in front of text describing something about the code.
@ -47,4 +47,4 @@ Function documentation describes the purpose and usage of a single function. Fun
#### More Information: #### More Information:
* [ElixirSchool - Documentation](https://elixirschool.com/en/lessons/basics/documentation/) * [ElixirSchool - Documentation](https://elixirschool.com/en/lessons/basics/documentation/)
* [ExDoc](https://github.com/elixir-lang/ex_doc) * [ExDoc](https://github.com/elixir-lang/ex_doc)