Skip to content

Commit

Permalink
minor BitStructure documentation cleanup
Browse files Browse the repository at this point in the history
  • Loading branch information
aconchillo committed Nov 5, 2012
1 parent 96c4f47 commit b26280b
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions src/BitPacket/BitStructure.py
Expand Up @@ -29,12 +29,12 @@
**API reference**: :class:`BitStructure` **API reference**: :class:`BitStructure`
The BitStructure class must be used, in conjunction with The :mod:`BitStructure` class must be used, in conjunction with
:mod:`BitField`, to create byte-aligned fields formed, internally, :mod:`BitField`, to create byte-aligned fields formed, internally,
by bit fields. by bit fields.
It is really important to understand that BitPacket is byte It is really important to understand that BitPacket is byte
oriented, therefore, a BitStructure must be byte-aligned. oriented, therefore, a :mod:`BitStructure` must be byte-aligned.
Consider the first byte of an IP header packet: Consider the first byte of an IP header packet:
Expand All @@ -59,9 +59,9 @@
(version = 0x0E) (version = 0x0E)
(hlen = 0x0C)) (hlen = 0x0C))
Note that the size of a BitStructure is returned in bytes. Remember Note that the size of a :mod:`BitStructure` is returned in
that the purpose of a BitStructure is to create a byte-aligned value bytes. Remember that the purpose of a :mod:`BitStructure` is to
that is built internally with bits: create a byte-aligned value that is built internally with bits:
>>> ip.size() >>> ip.size()
1 1
Expand Down

0 comments on commit b26280b

Please sign in to comment.