Fix documentation bugs #1224
Fix documentation bugs #1224
Conversation
There was a problem hiding this comment.
Hello @stefansundin, I have a couple minor comments. But overall it looks great! Thank you for taking the time to do this.
service/configservice/api.go
Outdated
| @@ -4029,6 +4029,7 @@ func (s *DeliveryChannel) SetSnsTopicARN(v string) *DeliveryChannel { | |||
| // The status of a specified delivery channel. | |||
| // | |||
| // Valid values: Success | Failure | |||
| // | |||
There was a problem hiding this comment.
For these i suggest just removing the api.go files from the PR. We can upstream these doc issues to the service teams
There was a problem hiding this comment.
@jasdel let me know when the api.go fixes have been sent upstream, and then I will undo the changes from the PR.
service/lambda/api.go
Outdated
| @@ -2974,7 +2974,7 @@ type AddPermissionInput struct { | |||
| _ struct{} `type:"structure"` | |||
|
|
|||
| // The AWS Lambda action you want to allow in this statement. Each Lambda action | |||
| // is a string starting with lambda: followed by the API name . For example, | |||
| // is a string starting with lambda: followed by the API name. For example, | |||
|
I just undid the Also, don't forget to fix the markdown lists that I took screenshots of. |
|
Thanks for pointing that out again. It looks like the markdown generator the SDK is using to convert the README.md file to an HTML page for "https://docs.aws.amazon.com/sdk-for-go/api/" isn't generating lists correctly at all. I'll take a look at the rules we have setup for that and see about getting this fixed. |
Cleaned up the README's header style and fixup to the godoc styling. Related aws#1224
Cleaned up the README's header style and fixup to the godoc styling. Related aws#1224
Cleaned up the README's header style and fixup to the godoc styling. Related #1224
Hello again, I am back with some more documentation fixes! :)
This time I went out of my way to hunt for both big and small issues. Let me know if you find any mistakes in my corrections.
Additionally, there are some bugs in the generated documentation. Since it appears the tool that is actually used to generate https://docs.aws.amazon.com/sdk-for-go/api/ is not open source, I couldn't actually fix these bugs, but here are some screenshots:
Ugly header
List not rendered
List not rendered