Skip to content

Commit

Permalink
doc: Update the doc comment for pactffi_given_with_param to indicate …
Browse files Browse the repository at this point in the history
…the value must be JSON #263
  • Loading branch information
rholshausen committed Apr 17, 2023
1 parent 10bf1a4 commit ac136ed
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions rust/pact_ffi/src/mock_server/handles.rs
Original file line number Diff line number Diff line change
Expand Up @@ -522,12 +522,14 @@ ffi_fn! {
}
}

/// Adds a provider state to the Interaction with a parameter key and value. Returns false if the interaction or Pact can't be
/// modified (i.e. the mock server for it has already started)
/// Adds a provider state to the Interaction with a parameter key and value. Returns false if the
/// interaction or Pact can't be modified (i.e. the mock server for it has already started).
///
/// The value will be parsed as JSON.
///
/// * `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_given_with_param(interaction: InteractionHandle, description: *const c_char,
name: *const c_char, value: *const c_char) -> bool {
Expand Down

0 comments on commit ac136ed

Please sign in to comment.