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(examples): Fix instructions and formatting in example app README #111

Merged
merged 2 commits into from
Sep 8, 2020

Conversation

jusiskin
Copy link
Contributor

Issue(s)

Fixes #105

Changes

  • The python example app README gave instructions for using the TypeScript UsageBasedLicense API. Fixed to use the python API.
  • Also fix up formatting in README markdown for both example app languages. The code blocks are now indented properly with each step's list item

Testing

  • Visually inspected the rendered markdown in VSCode's and GitHub's rendered markdown

  • Confirmed that the example APIs mentioned in the docs work properly using RFDK python packages:

    UsageBasedLicense.for_maya(10)
    UsageBasedLicense.for_arnold()

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

- fixes aws#105
- The python example app README gave instructions for using the
  TypeScript `UsageBasedLicense` API. Fixed to use the python API.
- Also fix up formatting in README markdown for both example app
  languages
@jusiskin jusiskin added the contribution/core This is a PR that came from AWS. label Aug 31, 2020
Copy link
Contributor

@yashda yashda left a comment

Choose a reason for hiding this comment

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

Look good. Thanks Josh!

@jusiskin jusiskin changed the title fix(examples): Fix UBL in python example app README fix(examples): Fix instructions and formatting in example app README Sep 8, 2020
@jusiskin jusiskin merged commit f050f41 into aws:mainline Sep 8, 2020
@jusiskin jusiskin deleted the python_sample_app_docs branch October 2, 2020 15:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
contribution/core This is a PR that came from AWS.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Error in documentation
3 participants