Added @return
doc comment annotations to methods in azure_client.rb
.
#655
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.
Background:
There were a few utility methods in
azure_client.rb
called by code related to PR #651 which had no doc comments. And some of those methods' implementations had changed over time so that their method names had become inaccurate. While adding return type annotations to those methods, I noticed many other methods in the same file which also lacked any doc comments and had names which weren't drectly indicative of the type of the value(s) returned, but which weren't directly related to #651.Since there were also many other un-annotated methods within
azure_client.rb
which also had names which were non-indicative of the return type (thus requiring a maintainer to read each method's implementations to understand what type of value would be returned), I opportunistically added@return
annotations to many of those methods, assuming that such annotations would be better than completely un-annotated methods. I am submitting these additional annotations as a separate PR since they weren't directly related to the functionality in #651.Checklist:
Please check each of the boxes below for which you have completed the corresponding task:
Please include below the summary portions of the output from the following 2 scripts:
NOTE: Please see how to setup dev environment and run unit tests in docs/development.md.
Unit Test output:
Rubocop output:
Changelog
@return
doc comment annotations to methods inazure_client.rb
.