This repository was archived by the owner on Jul 13, 2025. It is now read-only.
Ruby documentation fixes#1549
Merged
geigerj merged 3 commits intogoogleapis:masterfrom Sep 11, 2017
Merged
Conversation
Based on feedback from googleapis/google-cloud-ruby#1702 - Use "@overload" to prevent YARD from being confused when @param docs do not match the *args, **kwargs method signature - Do not use *args, **kwargs when the true method signature is known - End version index files in newline, per convention
Codecov Report
@@ Coverage Diff @@
## master #1549 +/- ##
============================================
+ Coverage 87.04% 87.04% +<.01%
- Complexity 4205 4207 +2
============================================
Files 408 408
Lines 16866 16868 +2
Branches 1832 1832
============================================
+ Hits 14681 14683 +2
Misses 1695 1695
Partials 490 490
Continue to review full report at Codecov.
|
evaogbe
approved these changes
Sep 8, 2017
landrito
approved these changes
Sep 8, 2017
| # @param timeout [Numeric] | ||
| # The default timeout, in seconds, for calls made through this client. | ||
| # @overload | ||
| # @param version [Symbol, String] |
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
This comment was marked as spam.
This comment was marked as spam.
Sorry, something went wrong.
- Move `version` param out of `@overload` section
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
4 participants
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.
Based on feedback from
googleapis/google-cloud-ruby#1702
@overloadto prevent YARD from being confused when@paramdocsdo not match the *args, **kwargs method signature