Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update tenses of doc comment summary lines (#4161)

Browse source 
This PR updates the tenses used by the summary line of doc comments to
match the [Rust API documentation
conventions](https://rust-lang.github.io/rfcs/1574-more-api-documentation-conventions.html#summary-sentence).

Specifically:

> The summary line should be written in third person singular present
indicative form. Basically, this means write ‘Returns’ instead of
‘Return’.

I'm sure there are plenty occurrences that I missed.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2024-01-19 11:18:50 -05:00 • committed by GitHub
parent cb1b7915ee
commit 01f06f96a1
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
19 changed files with 75 additions and 73 deletions
Download patch file Download diff file Expand all files Collapse all files

6
crates/plugin_runtime/src/plugin.rs
View file

@ -69,7 +69,7 @@ impl Default for Metering {
}
/// This struct is used to build a new [`Plugin`], using the builder pattern.
/// Create a new default plugin with `PluginBuilder::new_with_default_ctx`,
/// Creates a new default plugin with `PluginBuilder::new_with_default_ctx`,
/// and add host-side exported functions using `host_function` and `host_function_async`.
/// Finalize the plugin by calling [`init`].
pub struct PluginBuilder {
@ -90,7 +90,7 @@ fn create_default_engine() -> Result<Engine, Error> {
}
impl PluginBuilder {
/// Create a new [`PluginBuilder`] with the given WASI context.
/// Creates a new [`PluginBuilder`] with the given WASI context.
/// Using the default context is a safe bet, see [`new_with_default_context`].
/// This plugin will yield after a configurable amount of fuel is consumed.
pub fn new(wasi_ctx: WasiCtx, metering: Metering) -> Result<Self, Error> {
@ -105,7 +105,7 @@ impl PluginBuilder {
})
}
/// Create a new `PluginBuilder` with the default `WasiCtx` (see [`default_ctx`]).
/// Creates a new `PluginBuilder` with the default `WasiCtx` (see [`default_ctx`]).
/// This plugin will yield after a configurable amount of fuel is consumed.
pub fn new_default() -> Result<Self, Error> {
let default_ctx = WasiCtxBuilder::new()