Skip to content

Conversation

cholmes
Copy link
Member

@cholmes cholmes commented Mar 21, 2023

Related Issue(s):

Closes #

Proposed Changes:

For inclusion in changelog (if applicable):

  1. Added full documentation of subscriptions CLI

PR Checklist:

  • This PR is as small and focused as possible
  • If this PR includes proposed changes for inclusion in the changelog, the title of this PR summarizes those changes and is ready for inclusion in the Changelog.
  • [] I have updated docstrings for function changes and docs in the 'docs' folder for user interface / behavior changes
  • [] This PR does not break any examples or I have updated them

(Optional) @mentions for Notifications:

@cholmes cholmes requested a review from JuLeeAtPlanet March 21, 2023 03:26
@cholmes
Copy link
Member Author

cholmes commented Mar 21, 2023

@JuLeeAtPlanet - I think this has most everything documented for subscriptions. I didn't manage to fully test every command, so would definitely appreciate you going through and trying out everything I did, and ideally fully creating a subscription (like put in your auth stuff) to make sure it all works. Other feedback both big and small is also fully welcome - I made it pretty quickly in a spare couple of hours I had, so some stuff may be off.

@@ -303,7 +303,6 @@ of at least one being corrupted in creases
Now we'll dive into the variety of ways to customize your order. These can all be
combined with all the commands listed above.


Copy link
Member Author

@cholmes cholmes Mar 21, 2023

Choose a reason for hiding this comment

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

In merge caught that there was an extra space here.

`cancelled`, `preparing`, `pending`, `completed`, `suspended`, and `failed`.

### Describe Subscription
Copy link
Member Author

Choose a reason for hiding this comment

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

Note this section should change with #889 - just change the three places it says 'describe' with 'get' once that change is made.

Copy link
Contributor

Choose a reason for hiding this comment

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

FYI: PR #900 has been merged to main, which closed this ticket in reference.

@JuLeeAtPlanet JuLeeAtPlanet self-requested a review March 24, 2023 23:46
@JuLeeAtPlanet
Copy link
Contributor

@JuLeeAtPlanet - I think this has most everything documented for subscriptions. I didn't manage to fully test every command, so would definitely appreciate you going through and trying out everything I did, and ideally fully creating a subscription (like put in your auth stuff) to make sure it all works. Other feedback both big and small is also fully welcome - I made it pretty quickly in a spare couple of hours I had, so some stuff may be off.

Just read this more carefully, so I will go through and do a more detailed test of content before I finalize this second review.

@cholmes cholmes merged commit ce311a6 into main Mar 29, 2023
@cholmes cholmes deleted the subs-docs branch March 29, 2023 18:00
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.

3 participants