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

Data CLI documentation updates #891

Merged
merged 10 commits into from
Apr 11, 2023
Merged

Data CLI documentation updates #891

merged 10 commits into from
Apr 11, 2023

Conversation

cholmes
Copy link
Member

@cholmes cholmes commented Mar 22, 2023

Related Issue(s):

Closes #886, #885, #615

Proposed Changes:

For inclusion in changelog (if applicable):

  1. Documented CLI for data stats, saved search and asset functionality

Not intended for changelog:

  1. Asset had some documentation, but I updated to a consistent style / voice with the rest of the docs.

NOTE: - The new documentation in this PR will need to be updated when #884 lands, and also if #890 and #887 land. Changes should be simple/easy, but we should be sure to update. I originally started out the docs anticipating #884, but then I wasn't sure if the other two would land, so seemed easiest to just make the docs so they can merge immediately. Then if #884 lands first we can update this PR, and if this lands first we can update that PR.

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:

docs/cli/cli-data.md Outdated Show resolved Hide resolved
docs/cli/cli-data.md Outdated Show resolved Hide resolved
docs/cli/cli-data.md Outdated Show resolved Hide resolved
docs/cli/cli-data.md Outdated Show resolved Hide resolved
docs/cli/cli-data.md Outdated Show resolved Hide resolved
Copy link
Contributor

@JuLeeAtPlanet JuLeeAtPlanet left a comment

Choose a reason for hiding this comment

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

Please address typos (lines 149 & 329)

cholmes and others added 6 commits March 22, 2023 18:14
Co-authored-by: JuLee Burdekin <91982271+JuLeeAtPlanet@users.noreply.github.com>
Co-authored-by: JuLee Burdekin <91982271+JuLeeAtPlanet@users.noreply.github.com>
Co-authored-by: JuLee Burdekin <91982271+JuLeeAtPlanet@users.noreply.github.com>
Co-authored-by: JuLee Burdekin <91982271+JuLeeAtPlanet@users.noreply.github.com>
Co-authored-by: JuLee Burdekin <91982271+JuLeeAtPlanet@users.noreply.github.com>
@cholmes
Copy link
Member Author

cholmes commented Mar 23, 2023

Ok, made all the suggested changes. Note the first two were errors in the original file, not in the PR, so in the future it'd be easier if those are just done in a separate review. But went ahead and got them all in.

@cholmes
Copy link
Member Author

cholmes commented Mar 24, 2023

Updated for the syntax updates (#884, #887, #890). Note one still has to be merged. I'm not sure exactly how the docs builds work, but we probably don't want to publish this update until the next version is actually released. Note that #890 (Pr #898) is not yet closed, but I documented here anticipating that it would.

@JuLeeAtPlanet JuLeeAtPlanet merged commit 4c0a62d into main Apr 11, 2023
@jreiberkyle jreiberkyle deleted the docs-885-886 branch May 11, 2023 03:44
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.

add docs for asset-activate/download/wait commands
2 participants