Skip to content

Commit

Permalink
Update components/core/src/ffi/encoding_methods.hpp
Browse files Browse the repository at this point in the history
Co-authored-by: kirkrodrigues <[email protected]>
  • Loading branch information
LinZhihao-723 and kirkrodrigues authored Nov 9, 2023
1 parent bc295cd commit d164469
Showing 1 changed file with 3 additions and 4 deletions.
7 changes: 3 additions & 4 deletions components/core/src/ffi/encoding_methods.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,10 +83,9 @@ eight_byte_encoded_variable_t encode_four_byte_float_as_eight_byte(
);

/**
* Encodes a float value with the given properties into an encoded variable. It
* does not check whether the input can be safely encoded with the given
* encoding type. It is the caller's responsibility to validate whether the
* input is a representable float.
* Encodes a float value with the given properties into an encoded variable.
* NOTE: It's the caller's responsibility to validate that the input is a
* representable float.
* @tparam encoded_variable_t Type of the encoded variable
* @param is_negative
* @param digits The digits of the float, ignoring the decimal, as an
Expand Down

0 comments on commit d164469

Please sign in to comment.