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

chore: change doc comment for quickstart command #3427

Closed
wants to merge 1 commit into from

Conversation

ghost
Copy link

@ghost ghost commented Oct 30, 2023

Description

Adds the dfx quickstart to the dfx help menu.

Fixes # (issue)
https://dfinity.atlassian.net/browse/SDK-998

@ghost ghost requested review from chenyan-dfinity and a team as code owners October 30, 2023 16:05
@ericswanson-dfinity
Copy link
Member

ericswanson-dfinity commented Oct 30, 2023

Looks good (shortens the help text), but the bug in question seems to be out of date. The command does show help in dfx 0.15.1:

$ dfx --version
dfx 0.15.1
$ dfx quickstart --help
Use the `dfx quickstart` command to perform initial one time setup for your identity and/or wallet. This
command can be run anytime to repeat the setup process or to be used as an informational command, printing
information about your ICP balance, current ICP to XDR conversion rate, and more.

If setup tasks remain, this command is equivalent to running `dfx identity set-wallet` (for importing) or `dfx
ledger create-canister` followed by `dfx identity deploy-wallet` (for creating), though more steps may be
added in future versions.

Usage: dfx quickstart [OPTIONS]
...
$ dfx --help
The DFINITY Executor

Usage: dfx [OPTIONS] <COMMAND>

Commands:
...
  deps        Pull dependencies and integrate locally
  diagnose    Detects known problems in the current environment caused by upgrading DFX, and suggests commands to
                  fix them. These commands can be batch-run automatically via `dfx fix`
  fix         Applies one-time fixes for known problems in the current environment caused by upgrading DFX. Makes
                  no changes that would not have been suggested by `dfx diagnose`
  extension   Manages the dfx extensions
  generate    Generate type declarations for canisters from the code in your project
  identity    Manages identities used to communicate with the Internet Computer network. Setting an identity
                  enables you to test user-based access controls
  info        Get information about the replica shipped with dfx, path to networks.json, and network ports of
                  running replica
  ledger      Ledger commands
  new         Creates a new project
  ping        Pings an Internet Computer network and returns its status
  quickstart  Use the `dfx quickstart` command to perform initial one time setup for your identity and/or wallet.
                  This command can be run anytime to repeat the setup process or to be used as an informational
                  command, printing information about your ICP balance, current ICP to XDR conversion rate, and more
  remote      Commands used to work with remote canisters
  schema      Prints the schema for dfx.json
...
...

#[derive(Parser)]
pub struct QuickstartOpts;

// This command can be run anytime to repeat the setup process or to be used as an informational command, printing

Choose a reason for hiding this comment

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

These should probably all be // or ///, but not a mix

@ghost
Copy link
Author

ghost commented Oct 30, 2023

Thank you for reviewing Eric. I will close this PR as it looks like the issue is resolved in the latest.

@ghost ghost closed this Oct 30, 2023
@ericswanson-dfinity ericswanson-dfinity deleted the ji/update-quickstart-doc-comment branch May 6, 2024 21:59
This pull request was closed.
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.

1 participant