Skip to content

Conversation

@ranger-ross
Copy link
Contributor

This PR is a small QoL improvement to add doc comments to functions based on the endpoint method/path and the operation description.

The format is:

/// {METHOD} {PATH}
/// 
/// {NOTES} 

example:

/// POST /v1/foo
///
/// This creates a foo in the database.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (For Windows users, please run the script in Git BASH)
    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.
  • x ] File the PR against the correct branch: master (upcoming 7.x.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

cc: @frol @farcaller @richardwhiuk @paladinzh @jacob-pro

pub trait {{{classname}}}: Send + Sync {
{{#operations}}
{{#operation}}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: this newline is intentional to give a bit more space between functions to make them easier to read.

@wing328
Copy link
Member

wing328 commented Feb 5, 2025

@ranger-ross looks good to me. thanks for the contributions as always

@wing328 wing328 merged commit cba1936 into OpenAPITools:master Feb 5, 2025
20 checks passed
@ranger-ross ranger-ross deleted the better-rust-docs branch February 5, 2025 11:34
@wing328 wing328 added this to the 7.12.0 milestone Feb 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants