Created by: richardwhiuk
PR checklist
-
Read the contribution guidelines. -
Ran the shell script under ./bin/
to update Petstore sample so that CIs can verify the change. (For instance, only need to run./bin/{LANG}-petstore.sh
,./bin/openapi3/{LANG}-petstore.sh
if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in.\bin\windows\
. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first. -
Filed the PR against the correct branch: master
,4.1.x
,5.0.x
. Default:master
. -
Copied the technical committee to review the pull request if your PR is targeting a particular programming language. - @frol, @farcaller, @bjgill
Description of the PR
Generate valid Rustdocs for lazy_static items
Currently compiling a generated crate produced by rust-server produces warnings such as the follows:
warning: unused doc comment
--> output/rust-server-test/src/mimetypes.rs:15:5
|
15 | /// Create Mime objects for the response content types for RawJsonGet
| ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
16 | / lazy_static! {
17 | | pub static ref RAW_JSON_GET_SUCCESS: Mime = "*/*".parse().unwrap();
18 | | }
| |_____- rustdoc does not generate documentation for macro expansions
|
= help: to document an item produced by a macro, the macro must produce the documentation as part of its expansion
This fixes that. This work was contributed by @mthebridge