fix(python): parameter names in docstrings should be snake_case, not camelCase#539
Merged
eladb merged 2 commits intoaws:masterfrom Jun 24, 2019
garnaat:fix-538
Merged
fix(python): parameter names in docstrings should be snake_case, not camelCase#539eladb merged 2 commits intoaws:masterfrom garnaat:fix-538
eladb merged 2 commits intoaws:masterfrom
garnaat:fix-538
Conversation
eladb
reviewed
Jun 17, 2019
Contributor
eladb
left a comment
eladb
left a comment
There was a problem hiding this comment.
I would expect pacmak test expectations to be updated.
eladb
approved these changes
Jun 17, 2019
eladb
approved these changes
Jun 17, 2019
| optionalArray: | ||
| non_primitive: An example of a non primitive property. | ||
| another_optional: This is optional. | ||
| optional_any: |
Contributor
There was a problem hiding this comment.
What do we think about the params without text? how does this render? Should we add some placeholder text?
Contributor
Author
There was a problem hiding this comment.
Well, the current code returns a - character if there are not docs for the argument but that causes things to render funny, as in https://docs.aws.amazon.com/cdk/api/latest/python/aws_cdk.aws_ecs/Ec2Service.html#aws_cdk.aws_ecs.Ec2Service.add_placement_constraints. I think that should be changed, either to a blank character, empty string, or some other default string.
Contributor
There was a problem hiding this comment.
Not sure I follow... So this is okay?
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 join this conversation on GitHub.
Already have an account?
Sign in to comment
2 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.
Fixes #538.
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.