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

[DOCUMENTATION] Complete the example for sending relays #16

Closed
5 tasks
adshmh opened this issue Jun 24, 2024 · 1 comment
Closed
5 tasks

[DOCUMENTATION] Complete the example for sending relays #16

adshmh opened this issue Jun 24, 2024 · 1 comment
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@adshmh
Copy link
Contributor

adshmh commented Jun 24, 2024

Objective

Following the refactoring of the SDK, most recently in PR #15, it seems very helpful to have a complete example to guide the users in using the SDK for sending relays.

Origin Document

Here is a snapshot of a code snippet from relay_test.go which shows a generally correct, but incomplete example of how to send a relay request using the SDK:

image

Goals

  • Complete the above example
  • Update any comments as needed, more specifically target the godoc generated document.

Deliverables

  • Updated example for sending a relay (in relay_test.go)
  • Updated comments on functions/components involved in the above example.
  • ...

General deliverables

  • Comments: Add/update TODOs and comments alongside the source code so it is easier to follow.
  • Testing: Add new tests (unit and/or E2E) to the test suite.
  • Documentation: Update architectural or development READMEs; use mermaid diagrams where appropriate.

Creator: [adshmh]

@adshmh adshmh added the documentation Improvements or additions to documentation label Jun 24, 2024
@adshmh adshmh self-assigned this Jun 24, 2024
@red-0ne
Copy link
Collaborator

red-0ne commented Jul 1, 2024

Closed as per #15 and #19

@red-0ne red-0ne closed this as completed Jul 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants