feat(pacmak): put translated README into module docstring #900
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
We put in all this effort to convert code samples from TypeScript to Python, but they only were written in translated form to a README file that was used to publish to PyPI. When the packages are installed to a Python library directory, the README is gone (and so cannot be used by Sphinx to insert into the docs). Our own Sphinx generator was reading the README from the jsii assembly, but that README still contains the TypeScript examples. Insert the README content as a module-level docstrings so that the doc generator can read the right translated README version and put it in the docs. We keep the module docstring in MarkDown, not convert it to ReST, since our ReST conversion is not very reliable yet.
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
RomainMuller
approved these changes
Oct 23, 2019
package.json
Outdated
| @@ -27,5 +27,8 @@ | |||
| "nohoist": [ | |||
| "**/jsii-calc-bundled" | |||
| ] | |||
| }, | |||
| "dependencies": { | |||
| "yarn": "^1.19.1" | |||
There was a problem hiding this comment.
I would rather not...
There was a problem hiding this comment.
This was actually added by accident, so I'm happy to take it out. But I do wonder: why not, actually? Isn't it a convenient way to bootstrap yarn by using NPM? And then we can keep it nice & isolated.
RomainMuller
added
the
pr/do-not-merge
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
AWS CodeBuild CI Report
Powered by github-codebuild-logs, available on the AWS Serverless Application Repository |
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.
We put in all this effort to convert code samples from TypeScript
to Python, but they only were written in translated form to a README
file that was used to publish to PyPI. When the packages are installed
to a Python library directory, the README is gone (and so cannot be used
by Sphinx to insert into the docs).
Our own Sphinx generator was reading the README from the jsii assembly,
but that README still contains the TypeScript examples.
Insert the README content as a module-level docstrings so that the doc
generator can read the right translated README version and put it in the
docs. We keep the module docstring in MarkDown, not convert it to ReST,
since our ReST conversion is not very reliable yet.
Fixes #
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.