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

interledger-btp API review for v1.0-rc #570

Closed
8 tasks done
gakonst opened this issue Dec 18, 2019 · 2 comments
Closed
8 tasks done

interledger-btp API review for v1.0-rc #570

gakonst opened this issue Dec 18, 2019 · 2 comments
Assignees
Labels
crate/interledger-btp docs v1.0 Issues which need to be handled for a v1.0 release

Comments

@gakonst
Copy link
Member

gakonst commented Dec 18, 2019

interledger-btp public items marked with x are documented. Non-exported items are not taken into account. Follows format from #561.

Part of #557.

  • BtpAccount (trait)
    • Should the trait functions also be documented? Seem a bit self explanatory from the name
  • BtpStore (trait)
  • connect_client (fn)
  • connect_to_service_account (fn)
  • parse_btp_url (fn)
  • btp_service_as_filter (fn)
    • This is documented, but the comment is outdated. Needs to be updated to show that it converts the provided btp service to a warp filter
  • BtpOutgoingService (struct)
  • BtpService (struct)
@gakonst gakonst added this to To do in Towards a v1.0 Dec 18, 2019
@gakonst gakonst mentioned this issue Jan 20, 2020
11 tasks
@gakonst gakonst moved this from To do to In progress in Towards a v1.0 Jan 20, 2020
@gakonst gakonst self-assigned this Jan 20, 2020
@gakonst gakonst added v1.0 Issues which need to be handled for a v1.0 release docs labels Jan 20, 2020
@gakonst gakonst moved this from In progress to Waiting Review / Response in Towards a v1.0 Jan 20, 2020
@bstrie
Copy link
Contributor

bstrie commented Feb 4, 2020

  • parse_btp_url: remove it if we can get away with it

@gakonst
Copy link
Member Author

gakonst commented Feb 4, 2020

Yup it's been removed

@gakonst gakonst closed this as completed Feb 4, 2020
Towards a v1.0 automation moved this from Waiting Review / Response to Done Feb 4, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
crate/interledger-btp docs v1.0 Issues which need to be handled for a v1.0 release
Projects
No open projects
Development

No branches or pull requests

2 participants