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

[ENH] Add help docstring to init command #2849

Open
Adam-D-Lewis opened this issue Nov 12, 2024 · 8 comments · May be fixed by #2916
Open

[ENH] Add help docstring to init command #2849

Adam-D-Lewis opened this issue Nov 12, 2024 · 8 comments · May be fixed by #2916
Labels

Comments

@Adam-D-Lewis
Copy link
Member

Context

As you can see the info command has no docstring helper. The info command shows which plugins are installed. It'd be useful to add a documentation helper for the info command.
image

Value and/or benefit

Better UX

Anything else?

No response

@Adam-D-Lewis Adam-D-Lewis added the needs: triage 🚦 Someone needs to have a look at this issue and triage label Nov 12, 2024
@Adam-D-Lewis Adam-D-Lewis added the good first issue Good for newcomers label Nov 12, 2024
@Adam-D-Lewis Adam-D-Lewis added area: nebari-cli and removed needs: triage 🚦 Someone needs to have a look at this issue and triage labels Nov 12, 2024
@kernel-loophole
Copy link

@Adam-D-Lewis would love to work on this if anyone is not working on this .

@Adam-D-Lewis
Copy link
Member Author

Go for it @kernel-loophole! Feel free to reach out if you have questions.

@kernel-loophole
Copy link

@Adam-D-Lewis thanks

@kernel-loophole
Copy link

kernel-loophole commented Jan 18, 2025

@Adam-D-Lewis how can i compile the code to see what changes i have made and how changes affect .like if i have make changes in this https://github.com/nebari-dev/nebari/blob/main/src/_nebari/cli.py .do i have to push the changes in my nebari repo and then reinstall it using pip

@Adam-D-Lewis
Copy link
Member Author

You can pip install -e <local repo> and any changes will take effect l as soon as you make them

@kernel-loophole
Copy link

kernel-loophole commented Jan 20, 2025

@Adam-D-Lewis
Have a look .also there are some text improvement like -h ,AND showing TEXT in --import-plugin and --exclude-stage.it would be great if this also display the parameter or some helpful text .also fix this issue #2846

Image

@Adam-D-Lewis
Copy link
Member Author

Adam-D-Lewis commented Jan 20, 2025

Thankns @kernel-loophole, open a PR when you're ready and we can review it.

@kernel-loophole
Copy link

@Adam-D-Lewis thanks ,i have make PR #2916

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
Status: New 🚦
Development

Successfully merging a pull request may close this issue.

2 participants