@@ -5,27 +5,27 @@ list and release milestones.
55## Version Release Notes
66Release notes for the ` space_packet_parser ` library
77
8- ### v5.0.0 (unreleased )
9- - BREAKING: Main API changed. No need to create separate definition and parser objects any more. Create only a
8+ ### v5.0.0 (released )
9+ - * BREAKING* : Main API changed. No need to create separate definition and parser objects any more. Create only a
1010 definition from your XTCE document and instead of ` my_parser.generator ` , use ` my_packet_definition.packet_generator ` .
11- - BREAKING: Removed CSV-based packet definition support. We may indirectly support this in the future via
11+ - * BREAKING* : Removed CSV-based packet definition support. We may indirectly support this in the future via
1212 a utility for converting CSV definitions to XTCE.
13- - BREAKING: Separated out logical pieces into separate modules rather than everything
13+ - * BREAKING* : Separated out logical pieces into separate modules rather than everything
1414 living within the xtcedef module. This means user imports may be different now.
15- - BREAKING: Replace ` bitstring ` objects with native Python bytes objects
15+ - * BREAKING* : Replace ` bitstring ` objects with native Python bytes objects
1616 - Remove dependency on the ` bitstring ` library
1717 - Much faster parsing speed
1818 - Users that are passing ` bitstring.ConstBitStream ` objects to ` generator ` will need to pass a
1919 binary filelike object instead
20- - BREAKING: The `` ParsedDataItem `` class has been removed and the derived values are being returned now.
20+ - * BREAKING* : The `` ParsedDataItem `` class has been removed and the derived values are being returned now.
2121 The `` raw_value `` is stored as an attribute on the returned object. The other items can be accessed
2222 through the packet definition object `` my_packet_definition.named_parameters["my_item"].short_description ``
23- - BREAKING: The return type of BinaryDataEncoding is now the raw bytes.
23+ - * BREAKING* : The return type of BinaryDataEncoding is now the raw bytes.
2424 To get the previous behavior you can convert the data to an integer and then format it as a binary string.
2525 `` f"{int.from_bytes(data, byteorder='big'):0{len(data)*8}b}" ``
26- - BREAKING: Removed ` word_size ` kwarg from packet generator method.
26+ - * BREAKING* : Removed ` word_size ` kwarg from packet generator method.
2727 We expect all binary data to be integer number of bytes.
28- - BREAKING: Changed ` packet_generator ` kwarg ` skip_header_bits ` to ` skip_header_bytes ` .
28+ - * BREAKING* : Changed ` packet_generator ` kwarg ` skip_header_bits ` to ` skip_header_bytes ` .
2929- Fixed incorrect parsing of StringDataEncoding elements. Raw string values are now returned as byte buffers.
3030 Derived string values contain python string objects.
3131- The `` CCSDSPacket `` class is now a dictionary subclass, enabling direct lookup of items from the Packet itself.
0 commit comments