Testing Documentation #24
Conversation
nelsonic
added
the
in-review
README.md
Outdated
| #### Pipe Operator. What if we wanted to call some of our functions in succession | ||
| to another. Let's create a function that creates a zoo, randomises it and then | ||
| returns a selected number of animals to go and see: | ||
| #### Pipe Operator. What if we wanted to call some of our functions in succession to another. Let's create a function that creates a zoo, randomises it and then returns a selected number of animals to go and see: |
There was a problem hiding this comment.
@jackcarlisle I agree with having a sub-section for Pipe Operator but not a fan of the super-long <h4> heading ... could we re-word this?
README.md
Outdated
| end | ||
| end | ||
| ``` | ||
| **NOTE: It automatically includes a line called `doctest Animals`. What this means |
There was a problem hiding this comment.
Does the whole NOTE: ..." need to be bold
or could we make just the "Note" word bold and the rest of the text normal? 🤔
README.md
Outdated
| end | ||
| ``` | ||
|
|
||
| **NOTE: you do not need to install and require any external testing frameworks. |
There was a problem hiding this comment.
@jackcarlisle same here. NOTE -> Note: ... ?
There was a problem hiding this comment.
@jackcarlisle this is a superb addition to the learning resource! thanks!
I made a couple of comments on style.
@tomhuhges made a very valid point that our readmes should have more consistent formatting: dwyl/start-here#118
If you have time, please update.
Then assign to @iteles or @jruts for second review. thanks! ❤️
nelsonic
added
in-progress
|
@nelsonic README.md has been re-formatted! |
jackcarlisle
added
awaiting-review
iteles
added
in-review
|
Ha, I did NOT review these in the right order. |
There was a problem hiding this comment.
Another fantastic addition @jackcarlisle!
Some tiny formatting questions and then we're ready to go!
README.md
Outdated
| @@ -73,6 +85,7 @@ https://www.sitepoint.com/an-interview-with-elixir-creator-jose-valim/ | |||
| + What was "_wrong_" with just writing directly in Erlang? read: | |||
| http://www.unlimitednovelty.com/2011/07/trouble-with-erlang-or-erlang-is-ghetto.html | |||
|
|
|||
| *** | |||
There was a problem hiding this comment.
I think these tend to look a bit weird with the double lines caused by the titles, but not a blocker at all. We don't have these anywhere else so I might suggest we remove them for consistency.
README.md
Outdated
|
|
||
| ## Generating your first Elixir project | ||
|
|
||
| ## *Generating your first Elixir project* |
There was a problem hiding this comment.
Is this meant to italicise this title? Or did you mean to make it a 3 hash title (given no other titles are in italics)?
README.md
Outdated
| returns a selected number of animals to go and see: | ||
| #### Pipe Operator | ||
|
|
||
| What if we wanted to call some of our functions in succession to another. Let's create a function that creates a zoo, randomises it and then returns a selected number of animals to go and see: |
There was a problem hiding this comment.
Think there should be a question mark at the end of the first sentence? Is it not a question?
iteles
removed
the
in-review
|
@iteles changes made! |
|
@jruts All yours for review and merge please/thanks 💯 |
ready for review
README.mdon testing with Elixir#21