In-Code Documentation #226
Conversation
|
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. |
* `dispatch_http_call()` * `on_http_call_response()`` * `on_vm_start()` * `get_vm_configuration()` * `on_configure()` * `get_plugin_configuration()` * `set_tick_period()` * `on_tick()` * `on_http_request_headers()` * `get_http_request_headers()` * `get_http_request_header()` * `add_http_request_header()` * `resume_http_context()` * `send_http_response()` Signed-off-by: Anton Engelhardt <antoncengelhardt@icloud.com>
antonengelhardt
force-pushed
the
in-code-documentation
branch
from
ec2927d
to
d8b90e6
Compare
Signed-off-by: Anton Engelhardt <antoncengelhardt@icloud.com>
antonengelhardt
force-pushed
the
in-code-documentation
branch
from
4e79be6
to
03514d9
Compare
|
All examples do not include the |
|
@PiotrSikora What do you think? Sorry to ping you, but I think this would be a great benefit for DX |
There was a problem hiding this comment.
@PiotrSikora What do you think? Sorry to ping you, but I think this would be a great benefit for DX
I agree those would be very helpful. Sorry for the delay, I'll review this in the coming days.
src/traits.rs
Outdated
| /// | ||
| /// impl HttpContext for MyHttpContext { | ||
| /// fn on_http_request_headers(&mut self, _num_headers: usize, _end_of_stream: bool) -> Action { | ||
| /// let auth = self.get_http_request_header("Authorization").unwrap_or_defauklt(); |
There was a problem hiding this comment.
defauklt -> default, which means that those examples are not tested/build in the doc publishing process.
There was a problem hiding this comment.
Sorry about that. I was a little careful when copy and pasting stuff, because it always messed up the doc formatting. But i have tested it ;)
… stuff Signed-off-by: Anton Engelhardt <antoncengelhardt@icloud.com>
@PiotrSikora I tested all documented functions again and set up a repo with 7 folders that cover all functions. It might still be that something is missing. I will do some diffs on the docs and the testing-repo-files to see if anything is missing apart from the boilerplate stuff ( I hope this makes the review as easy as possible. |
Signed-off-by: Anton Engelhardt <antoncengelhardt@icloud.com>
Signed-off-by: Anton Engelhardt <antoncengelhardt@icloud.com>
antonengelhardt
force-pushed
the
in-code-documentation
branch
from
3ea0a4d
to
c11460b
Compare
|
I can squash my changes into one commit, if required. |
|
@PiotrSikora I can also add the examples from the mentioned repo to the |
In-Code Documentation for the following functions:
dispatch_http_call()on_http_call_response()on_vm_start()get_vm_configuration()on_configure()get_plugin_configuration()set_tick_period()on_tick()on_http_request_headers()get_http_request_headers()get_http_request_header()add_http_request_header()resume_http_context()send_http_response()Inspired by proxy-wasm/spec#42
Why?
To have documentation in your editor: