Skip to content
This repository has been archived by the owner on Sep 8, 2024. It is now read-only.

Fix #2604 Add missing commands to help #2613

Merged
merged 4 commits into from
Jun 22, 2020
Merged

Conversation

krisgesling
Copy link
Contributor

Description

  • Adds some missing commands to the mycroft-help list
  • minor restructure for clarity.
  • change more info link to point to documentation

Fixes #2604

Consideration should also be given to adding a mycroft --help option.

How to test

Run mycroft-help and ensure the output and descriptions are clear.

Contributor license agreement signed?

@devops-mycroft devops-mycroft added the CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) label Jun 8, 2020
@devops-mycroft
Copy link

Voight Kampff Integration Test Failed (Results)

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@forslund
Copy link
Collaborator

Looks good and works as intended.

A couple of small things that is probably outside the scope here:

  • The first character is not always capitalized (seemingly randomly). Might be something that can be addressed as well (but may be outside the scope of this PR).
  • The venv-activate.sh is mentioned here, it is runnable like a shell script but will only print the instruction to source it.

Maybe a couple of newbie friendly issues could be created for these changes?

@krisgesling
Copy link
Contributor Author

Good call regarding capitalization.

  • The venv-activate.sh is mentioned here, it is runnable like a shell script but will only print the instruction to source it.

I can't see a direct reference to that shell script. However the mycroft-venv-activate is a weird one as it's only handled through aliases. If you run deactivate instead of mycroft-venv-deactivate then the aliasing gets out of sync and you only have mycroft-venv-deactivate available...

I think we need to reconsider how we handle that. But outside the scope of this PR and I've left it in for now.

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@krisgesling krisgesling merged commit 1c9441e into dev Jun 22, 2020
@krisgesling krisgesling deleted the feature/command-help branch September 2, 2020 21:01
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Suggestion to add 'mycroft-config edit _' to the 'mycroft-start --help' menu.
3 participants