Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(pacmak): put package README into the right Python module #928

Merged
merged 2 commits into from
Nov 4, 2019

Conversation

rix0rrr
Copy link
Contributor

@rix0rrr rix0rrr commented Nov 1, 2019

The (translated) Python README used to be written to the
<module>._jsii module, as opposed to the main module.

Put it in the right module where people will actually look for it.

Fixes #


By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

The (translated) Python README used to be written to the
`<module>._jsii` module, as opposed to the main module.

Put it in the right module where people will actually look for it.
@rix0rrr rix0rrr requested a review from a team as a code owner November 1, 2019 10:06
@rix0rrr rix0rrr self-assigned this Nov 1, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@@ -1,3 +1,6 @@
"""
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

does it make sense to include an empty docstring or perhaps omit it if it's empty?

heading will be used as the Sphinx topic name. Otherwise, the name of the module
(`jsii-calc`) will be used instead.

## Code Samples
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Wow!

@RomainMuller RomainMuller added the pr/do-not-merge This PR should not be merged at this time. label Nov 4, 2019
@aws-cdk-automation
Copy link
Collaborator

AWS CodeBuild CI Report

  • Result: SUCCEEDED
  • Build Logs (available for 30 days)

Powered by github-codebuild-logs, available on the AWS Serverless Application Repository

@rix0rrr rix0rrr merged commit 17dd60f into master Nov 4, 2019
@rix0rrr rix0rrr deleted the huijbers/docstring-right-module branch November 4, 2019 16:39
@RomainMuller RomainMuller removed the pr/do-not-merge This PR should not be merged at this time. label Nov 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants