Skip to content

Delete examples folder of orbital

Andrew Mackenzie requested to merge andrewdavidmackenzie/orbital:remove_simple_example into master

This MR deleted the examples folder in orbital, and explains in readme where to find examples (orbclient/examples).

My reasoning for removing example here is:

  • Any sample is necessarily an example of using the client, not orbital.
  • There are no dependencies on orbital on the example (which makes sense given the above)
  • There are _only_dependencies on orbclient in the sample, underlining it's an example for orbclient not orbital
  • The simple.rs example is identical to the simple.rs example in orbclient, where there are additional samples
  • It is not built in CI, but any examples should be to ensure they are still valid
  • It's just extra work to maintain here, and causes confusion, better to do that from orbclient, where changes to the client API can be made synchronized with changes to the examples using that client.

Merge request reports