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

docs: add xrpl.js code snippets over to xrpl-py #443

Merged
merged 16 commits into from Oct 7, 2022

Conversation

connorjchen
Copy link
Collaborator

@connorjchen connorjchen commented Sep 23, 2022

High Level Overview of Change

Ported xrpl.js code snippets over to xrpl-py

Context of Change

Code snippets are a great way for developers in the community to learn from

Type of Change

  • Documentation Updates

Test Plan

Ran each file individually (claim_payment_channel fails because missing hashing function now)

@connorjchen connorjchen marked this pull request as draft September 23, 2022 19:03
@connorjchen connorjchen marked this pull request as ready for review September 23, 2022 19:09
Copy link
Collaborator

@mvadari mvadari left a comment

Choose a reason for hiding this comment

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

I would write these with the JsonRpcClient (unless you want to write a snippet with each client, which seems like too much).

@connorjchen connorjchen marked this pull request as draft September 26, 2022 15:21
@connorjchen connorjchen marked this pull request as ready for review September 26, 2022 15:54
docs/source/snippets.rst Outdated Show resolved Hide resolved
docs/source/snippets.rst Outdated Show resolved Hide resolved
docs/source/snippets.rst Outdated Show resolved Hide resolved
Copy link
Collaborator

@mvadari mvadari left a comment

Choose a reason for hiding this comment

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

A couple of notes:

  • Please add a multisign snippet (this could be in a separate PR if you'd prefer)
  • Please add these as tests (this would probably best done by importing the file in a test, since the file will run when it's imported)

docs/source/snippets.rst Outdated Show resolved Hide resolved
snippets/set_regular_key.py Outdated Show resolved Hide resolved
@connorjchen connorjchen merged commit b2216de into XRPLF:master Oct 7, 2022
@connorjchen connorjchen deleted the code-snippets branch October 7, 2022 20:35
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.

None yet

4 participants