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

Add some client examples to docs #669

Merged
merged 18 commits into from
Jun 26, 2023
Merged

Add some client examples to docs #669

merged 18 commits into from
Jun 26, 2023

Conversation

Dr-Electron
Copy link
Contributor

@Dr-Electron Dr-Electron commented Jun 22, 2023

Description of change

Added some client examples.

TODOs:

  • I wanted to add a get_routes example to check if the indexer plugin is enabled. But then I saw there is no function for that in the bindings yet. Or did I overlook something?
  • In python the function is called get_node_health instead of get_health. And the function is broken. I will update it

Links to any relevant issues

Fixes #599

Type of change

  • Documentation Enhancement

How the change has been tested

Tested locally

Change checklist

  • I have followed the contribution guidelines for this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that new and existing unit tests pass locally with my changes

@Dr-Electron Dr-Electron mentioned this pull request Jun 22, 2023
6 tasks
Copy link
Contributor

@kwek20 kwek20 left a comment

Choose a reason for hiding this comment

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

Soooo for the nodejs example output (output=result of running a command) weve updated the types so now they have a differnet output. Whats the strategy for this? when do we update the output?

@thibault-martinez thibault-martinez merged commit cb52281 into iotaledger:develop Jun 26, 2023
@Dr-Electron Dr-Electron deleted the docs/client-examples branch June 26, 2023 20:03
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.

Create most important client examples
4 participants