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

DOC: cleanup Usage section #5

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DOC: cleanup Usage section #5

wants to merge 1 commit into from

Conversation

drux007
Copy link
Member

@drux007 drux007 commented Nov 23, 2022

Under Usage section, I noticed:

deactivate               # deactivate the current active environment

is shown three times. Not sure how I didn't notice it last time ^^

This pull request cleans it up.

@drux007 drux007 requested a review from hagenw November 23, 2022 14:26
@drux007 drux007 added the documentation Improvements or additions to documentation label Nov 23, 2022
@hagenw
Copy link
Member

hagenw commented Nov 23, 2022

Now I get it. It was also the reason why envs was there more than one time. The current usage section does not simply list all commands, but provides an example of a possible workflow. For that reason it deactivates more than one environment.

I'm not sure yet if we should change to listing all commands and adding a small example afterwards?

@drux007
Copy link
Member Author

drux007 commented Nov 24, 2022

Ahaa now I get it!

It wasn't clear to me from the beginning. I came here to search for the commands first.

So maybe by splitting it into 2 sections where we:

  • list all available commands
  • add possible workflow

would be clearer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants