Add !-variants of request methods and improve yardocs #119
Conversation
This file contains 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
kke
commented
May 10, 2019
| @@ -10,6 +10,9 @@ module API | |||
| module MetaV1 | |||
| # @see https://godoc.org/k8s.io/apimachinery/pkg/apis/meta/v1#TypeMeta | |||
| class Resource < Struct | |||
| # @!macro [attach] attribute | |||
There was a problem hiding this comment.
This makes all of the api struct docs get documentation for their attributes.
Before:
After:
kke
commented
May 10, 2019
| @@ -21,7 +21,8 @@ | |||
|
|
|||
| module K8s | |||
| # @param server [String] http/s URL | |||
| # @param options [Hash] @see Transport.new | |||
| # @param options [Hash] | |||
| # @param (see Transport#initialize) | |||
There was a problem hiding this comment.
This syntax copies the params from the referenced method to this one. The link didn't work anyway.
kke
commented
May 10, 2019
| @@ -133,7 +133,7 @@ def self.from_kubeconfig_env(kubeconfig = nil) | |||
| # | |||
| # @param server [String] kubernetes server address | |||
| # @param ca [String] server certificate authority data (base64 encoded) | |||
| # @param token [String] access token | |||
| # @param auth_token [String] access token | |||
There was a problem hiding this comment.
Wrong attribute name, yardoc warns about these when generating, we could add rubocop-like test step for yardoc validity.
kke
commented
May 10, 2019
| module ExceptionlessBangMethod | ||
| private | ||
|
|
||
| # @!macro [attach] exceptionless_bang_method |
There was a problem hiding this comment.
This documents the dynamically generated bang! methods, but I couldn't find any way to replicate the param list / return value, so the bang-variants just show (*args, **options) => Object in the final doc.
kke
commented
May 10, 2019
added 2 commits
May 10, 2019 15:25
|
Too complicated implementation |
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.
Fixes #109
Also includes a bunch of fixes and improvements to yardocs all over, such as automatic documentation of the struct attributes.