Skip to content

Commit

Permalink
Add better documentation of what datums are.
Browse files Browse the repository at this point in the history
  • Loading branch information
npjg committed May 22, 2024
1 parent b520c85 commit 1971b40
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/MediaStation/Primitives/Datum.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,19 @@
from .Point import Point
from .Reference import Reference

## A datum that can be read from a binary stream.
## Provides the type of the value before the actual value.
## Except for compressed image data and audio data,
## nearly all data in Media Station files is encapsulated
## in "datums", so called because they generally represent
## the smallest units of useful data in Media Station data files.
##
## A datum provides a 16-bit type code, followed by a variable-
## length data section, whose length is generally defined
## by the type code.
## Here is an example, where `xx` represents one byte:
## Type code
## | Data
## | |
## xx xx xx xx .. xx xx
## TODO: Add type assertions for extra checking.
class Datum:
## The various known datum type codes.
Expand Down

0 comments on commit 1971b40

Please sign in to comment.