Document hostcalls::dispatch_http_call

[younes-io]

I think functions should be documented to make it easy to find (regardless of the ABI, which is now being written, cf. proxy-wasm/spec#41)

[google-cla]

Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA).

View this failed invocation of the CLA check for more information.

For the most up to date status, view the checks section at the bottom of the pull request.

[younes-io]

is there any issue here ?

[PiotrSikora]

is there any issue here ?

It doesn't pass tests (see Clippy failures).

Also, I believe that @mpwarres and @martijneken are currently working on the documentation for the whole SDK, so it might be worth waiting a bit for it for the sake of consistency. @mpwarres @martijneken do you have status update?

[mpwarres]

Also, I believe that @mpwarres and @martijneken are currently working on the documentation for the whole SDK, so it might be worth waiting a bit for it for the sake of consistency. @mpwarres @martijneken do you have status update?

C++ SDK doc PR should be out end of this week, Rust SDK PR early next week.

[cuisongliu]

/// # Returns
///
/// A Result indicating the success or failure of the HTTP call. If the call is successful, the function returns an HTTP status code as a u32. If an error occurs, an Error object is returned.

There may be some problems with this description. It seems that the return is not an HTTP status code, but the code looks more like a token_id

[younes-io]

@PiotrSikora : is this still relevant or shall I close it ?

[younes-io]

@mpwarres : could you please tell if this PR is still relevant or is obsolete (due to the latest work on docs, etc) ?

[younes-io]

@mpwarres @martijneken @PiotrSikora: For your information, I'm closing this as it's been more than one year and a half, and it seems abandoned.

[antonengelhardt]

@younes-io Maybe you want to take a look at #226? I tried to document some functions and added CI tests to check if the examples compile.

[younes-io]

@younes-io Maybe you want to take a look at #226? I tried to document some functions and added CI tests to check if the examples compile.

Will do! Thank you!