Skip to content

Commit 9c01303

Browse files
author
kidp330
committed
Update chapter 5
1 parent 3ceb2d0 commit 9c01303

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

basic_pipeline/05_Formats.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# Formats
1+
# Stream formats in action
22

3-
Since we have already discussed what caps are and how to use them, let's make use of them in our project!
3+
Since we have already discussed what stream formats are and how to use them, let's make use of them in our project!
44
The first thing to do is to define modules responsible for describing the formats used in our pipeline.
55
We will put them in a separate directory - `lib/formats`. Let's start with the format describing the [packets](../glossary/glossary.md#packet):
66

7-
**_`lib/formats/PacketFormat.ex`_**
7+
**_`lib/formats/packet_format.ex`_**
88

99
```elixir
1010
defmodule Basic.Formats.Packet do
@@ -15,11 +15,11 @@ defmodule Basic.Formats.Packet do
1515
end
1616
```
1717

18-
The definition of the module is not complicated, as you can see in the code snippet above - we are only defining a structure within that module, with a `:type` parameter, which default value is `:custom_packtes`.
18+
The definition of the module is not complicated, as you can see in the code snippet above - we are only defining a structure within that module, with a `:type` parameter, whose default value is `:custom_packets`.
1919

2020
In our [pipeline](../glossary/glossary.md#pipeline) we will also send another type of data - [frames](../glossary/glossary.md#frame). Let's define a format for them:
2121

22-
**_`lib/formats/FrameFormat.ex`_**
22+
**_`lib/formats/frame_format.ex`_**
2323

2424
```elixir
2525
defmodule Basic.Formats.Frame do
@@ -32,7 +32,7 @@ end
3232

3333
Same as in the case of the previous format - we are defining a structure with a single field, called `:encoding`, and the default value of that field - `:utf8`.
3434

35-
That's it! Format modules are really simple - the more complicated thing is to make use of them - which we will do in the subsequent chapters while defining the caps!
35+
That's it! Format modules are really simple - the more complicated thing is to make use of them - which we will do in the subsequent chapters while defining the specs!
3636

3737
Before advancing you can test the `Source` [element](../glossary/glossary.md/#source), using the tests provided in `/test` directory.
3838

0 commit comments

Comments
 (0)