From 82e570a1480d17ec6444ca86adee52d70dd0ffba Mon Sep 17 00:00:00 2001 From: "tien.xuan.vo" Date: Thu, 31 Oct 2024 17:18:45 +0700 Subject: [PATCH] docs: Update comment for pactffi_message_given_with_param --- rust/pact_ffi/src/mock_server/handles.rs | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/rust/pact_ffi/src/mock_server/handles.rs b/rust/pact_ffi/src/mock_server/handles.rs index 3453b59c..a252ff02 100644 --- a/rust/pact_ffi/src/mock_server/handles.rs +++ b/rust/pact_ffi/src/mock_server/handles.rs @@ -2795,11 +2795,14 @@ pub extern fn pactffi_message_given(message: MessageHandle, description: *const } } -/// Adds a provider state to the Message with a parameter key and value. +/// Adds a parameter key and value to a provider state to the Message. If the provider state +/// does not exist, a new one will be created, otherwise the parameter will be merged into the +/// existing one. The parameter value will be parsed as JSON. /// +/// # Parameters /// * `description` - The provider state description. It needs to be unique. /// * `name` - Parameter name. -/// * `value` - Parameter value. +/// * `value` - Parameter value as JSON. #[no_mangle] pub extern fn pactffi_message_given_with_param(message: MessageHandle, description: *const c_char, name: *const c_char, value: *const c_char) {