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

Update readme with simple example how to use this library #33

Closed
nvborisenko opened this issue Jan 31, 2019 · 5 comments · Fixed by #80
Closed

Update readme with simple example how to use this library #33

nvborisenko opened this issue Jan 31, 2019 · 5 comments · Fixed by #80
Assignees

Comments

@nvborisenko
Copy link
Member

Examples would be

  • Reporting several test items with logs to the server
  • Get the latest launch and fetch all test items
@nvborisenko
Copy link
Member Author

Easiest and great possibility to do it would be using dotnet-try interactive tool for documentation. We will describe samples, and user will be able to execute these samples.

@winstondz
Copy link

Some of the examples, I see use the CreateLogItemRequest which I think is depreciated. How do we attach a file (screenshot) using this package? Is there an example (stackoverflow) you can point me to?

@nvborisenko
Copy link
Member Author

@unickq
Copy link

unickq commented Jul 20, 2021

2 years, no docs 🤒

@nvborisenko
Copy link
Member Author

Only one entry point:

var service = new Service(uri, project, token);

Then intellisense does a magic. For instance start new launch:

var launch = await service.Launch.StartAsync(new StartLaunchRequest.......

Feel free to contribute, dn't hesitate to propose requests for change. Hoping test project describes how to use this library (covers 83% of code).

PS: inline doc instructions doesn't work, we need choose good library for inheritance of inline documentation.

Roadmap options:

  • just readme file
  • jupyter notebooks where you can play within predefined examples interactively
  • centralized doc for the whole RP.NET world

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 a pull request may close this issue.

4 participants