Added link to xref to readme file #78
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Not all readers know what xref is. So make it "resolvable" without using [yacy](http://yacy.net/en/index.html) or google.
Andalso added "definition" of iolist from erlang page.
|
another addition to my fork, master branch: |
|
Thanks @LuboVarga :) |
sheldonci
reviewed
Mar 20, 2017
| @@ -204,7 +204,7 @@ See also: [More, smaller functions over case expressions](#more-smaller-function | |||
|
|
|||
| *Examples*: [dyn_calls](src/dyn_calls.erl) | |||
|
|
|||
| *Reasoning*: Dynamic calls can't be checked by ``xref``, one of the most useful tools in the Erlang world. | |||
| *Reasoning*: Dynamic calls can't be checked by [``xref``](http://erlang.org/doc/apps/tools/xref_chapter.html), one of the most useful tools in the Erlang world. ``xref`` is a cross reference checking/observing tool. | |||
|
|
|||
| *** | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
sheldonci
reviewed
Mar 20, 2017
| @@ -321,7 +321,7 @@ Erlang syntax is horrible amirite? So you might as well make the best of it, rig | |||
|
|
|||
| *Examples*: [iolists](src/iolists.erl) | |||
|
|
|||
| *Reasoning*: Performance | |||
| *Reasoning*: Performance and errors during conversion. [iolists](http://www.erlangpatterns.org/iolist.html) are just deeply nested lists of integers and binaries to represent IO data to avoid copying when concatenating strings or binaries. | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
- Reasoning
sheldonci
reviewed
Mar 20, 2017
| @@ -321,7 +321,7 @@ Erlang syntax is horrible amirite? So you might as well make the best of it, rig | |||
|
|
|||
| *Examples*: [iolists](src/iolists.erl) | |||
|
|
|||
| *Reasoning*: Performance | |||
| *Reasoning*: Performance and errors during conversion. [iolists](http://www.erlangpatterns.org/iolist.html) are just deeply nested lists of integers and binaries to represent IO data to avoid copying when concatenating strings or binaries. | |||
|
|
|||
| ### Macros | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
sheldonci
reviewed
Mar 20, 2017
| @@ -204,7 +204,7 @@ See also: [More, smaller functions over case expressions](#more-smaller-function | |||
|
|
|||
| *Examples*: [dyn_calls](src/dyn_calls.erl) | |||
|
|
|||
| *Reasoning*: Dynamic calls can't be checked by ``xref``, one of the most useful tools in the Erlang world. | |||
| *Reasoning*: Dynamic calls can't be checked by [``xref``](http://erlang.org/doc/apps/tools/xref_chapter.html), one of the most useful tools in the Erlang world. ``xref`` is a cross reference checking/observing tool. | |||
|
|
|||
| *** | |||
| ##### Group modules in subdirectories by functionality | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
sheldonci
reviewed
Mar 20, 2017
| @@ -204,7 +204,7 @@ See also: [More, smaller functions over case expressions](#more-smaller-function | |||
|
|
|||
| *Examples*: [dyn_calls](src/dyn_calls.erl) | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
- Examples
sheldonci
reviewed
Mar 20, 2017
| @@ -321,7 +321,7 @@ Erlang syntax is horrible amirite? So you might as well make the best of it, rig | |||
|
|
|||
| *Examples*: [iolists](src/iolists.erl) | |||
There was a problem hiding this comment.
I found 1 misspelled word in this sentence:
- Examples
sheldonci
reviewed
Mar 20, 2017
| @@ -204,7 +204,7 @@ See also: [More, smaller functions over case expressions](#more-smaller-function | |||
|
|
|||
| *Examples*: [dyn_calls](src/dyn_calls.erl) | |||
|
|
|||
| *Reasoning*: Dynamic calls can't be checked by ``xref``, one of the most useful tools in the Erlang world. | |||
| *Reasoning*: Dynamic calls can't be checked by [``xref``](http://erlang.org/doc/apps/tools/xref_chapter.html), one of the most useful tools in the Erlang world. ``xref`` is a cross reference checking/observing tool. | |||
There was a problem hiding this comment.
I found 3 misspelled words in this sentence:
- checking/observing
- Erlang
- Reasoning
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not all readers know what xref is. So make it "resolvable" without using yacy or google.
added link to iolist in readme, and also added "definition" of iolist from erlang page.