feat(Python): Format docstrings #586
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
robin-aws
reviewed
Sep 17, 2024
| @@ -374,13 +374,6 @@ protected void writeFromDict(boolean isError) { | |||
| () -> { | |||
| writer.writeDocs(() -> { | |||
| writer.write("Creates a $L from a dictionary.\n", shapeName); | |||
| writer.write( | |||
There was a problem hiding this comment.
This is unrelated removal of comments that weren't supposed to be user-facing in the first place?
There was a problem hiding this comment.
This comment is inaccurate for Python codegen (and is inaccurate for Smithy-Python codegen).
- Formatting according to docstring note:
SomeMemberName- This is the "boto3" formatting.
- Actual Smithy-Python formatting:
someMemberName - Smithy-Dafny Python formatting:
some_member_name
robin-aws
approved these changes
Sep 17, 2024
ShubhamChaturvedi7
pushed a commit
that referenced
this pull request
Oct 18, 2024
Format docstrings. See https://aws-cryptographic-material-providers-library.readthedocs.io/en/latest/generated/aws_cryptographic_materialproviders.smithygenerated.aws_cryptography_keystore.models.html for an example. Before, the parameters and function descriptions were not displaying correctly because the docstrings weren't formatted. Now, they are appearing correctly.
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.
Issue #, if available:
Description of changes:
Format docstrings.
See https://aws-cryptographic-material-providers-library.readthedocs.io/en/latest/generated/aws_cryptographic_materialproviders.smithygenerated.aws_cryptography_keystore.models.html for an example.
Before, the parameters and function descriptions were not displaying correctly because the docstrings weren't formatted.
Now, they are appearing correctly.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.