Clean lifetimes markup in code documentation #1138
Labels
• docs
Related to `Documentation/rust/`, `samples/`, generated docs, doctests, typos...
easy
Expected to be an easy issue to resolve.
good first issue
Good for newcomers
In some places in the kernel tree we are writing lifetimes as:
/// ... 'a ...
without a Markdown code span. It would be nice to clean those following how we do it for other cases (as well as how the standard library does it).
This requires submitting a proper patch to the LKML and the Rust for Linux mailing list. Please recall to test your changes (including generating the documentation if changed, running the Rust doctests if changed, etc.), to use a proper title for the commit, to sign your commit under the Developer's Certificate of Origin and to add a
Suggested-by: tag
and aLink:
tag to this issue. Please see https://docs.kernel.org/process/submitting-patches.html and https://rust-for-linux.com/contributing for details.Please take this issue only if you are new to the kernel development process and you would like to use it as a test to submit your first patch to the kernel. Please do not take it if you do not plan to make other contributions to the kernel.
The text was updated successfully, but these errors were encountered: