Qualify rust trait template comments#21527
Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom Jul 8, 2025
Merged
Conversation
Member
|
lgtm. thanks for the contribution |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The doc links for parameter and error structs in the
reqwest-traittemplate were copied over from thereqwesttemplate, but they are not valid as-is, as these functions are now part of a trait and not standalone functions. This means for them to work correctly in IDEs and docs you need to qualify them with the trait name.For example, VSCode, shows the link with a different color and displays a preview of the function, plus clicking on the name would navigate to the function.

With this change:
Without this change:

I've also removed the trailing whitespace from the template file, let me know if you prefer that to be reverted and split into a separate PR.
Tagging openapi-generator Rust committee, like the checklist mentions: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)