Make apitodoc support Ptrs and update docs #288
Merged
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
KalmanMeth
reviewed
Aug 24, 2022
| @@ -35,7 +35,7 @@ func iterate(output io.Writer, data interface{}, indent int) { | |||
| if dataType == reflect.Slice || dataType == reflect.Map { | |||
There was a problem hiding this comment.
There are some commented out statements in this function (lines 33, 44). Should these be removed?
There was a problem hiding this comment.
I didn't write them. But, it seems that line 33 is used in the commented out debug code in lines 36 and 41.
I don't see the point of line 44. I'll remove it.
KalmanMeth
approved these changes
Aug 24, 2022
Codecov Report
@@ Coverage Diff @@
## main #288 +/- ##
==========================================
+ Coverage 67.33% 67.39% +0.05%
==========================================
Files 73 73
Lines 4271 4278 +7
==========================================
+ Hits 2876 2883 +7
Misses 1212 1212
Partials 183 183
Flags with carried forward coverage won't be shown. Click here to find out more.
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
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.
This PR enhances the apitodoc script to parse struct pointers in the API such as in the following cases:
flowlogs-pipeline/pkg/api/ingest_kafka.go
Line 30 in 9b96359
flowlogs-pipeline/pkg/api/encode_prom.go
Line 30 in 9b96359