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

Clarify that gui.clear does not close a Skill #2769

Merged
merged 1 commit into from
Dec 1, 2020

Conversation

krisgesling
Copy link
Contributor

Description

Clarify docstring for gui.clear method. This method does not close a Skill / release the GUI from it. Tweaks / amendments / suggestions most welcome!

A new release method is being added in PR #2766 for this purpose

How to test

Documentation update only.

Contributor license agreement signed?

@krisgesling krisgesling added Type: Refactoring and other improvements Improvement of code and documentation that does not alter functionality. CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) labels Nov 30, 2020
forslund
forslund previously approved these changes Nov 30, 2020
Copy link
Collaborator

@forslund forslund left a comment

Choose a reason for hiding this comment

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

A good clarification!

Possible nit-pick the closing """ are usually put on a separate line unless it's a single line docstring. Not sure this is the standard though.

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@krisgesling
Copy link
Contributor Author

You are correct - fixed!

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@krisgesling krisgesling requested a review from forslund December 1, 2020 13:53
Copy link
Collaborator

@forslund forslund left a comment

Choose a reason for hiding this comment

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

Looks excellent now.

@forslund forslund merged commit 259d243 into dev Dec 1, 2020
@forslund forslund deleted the feature/gui-clear-docstring branch December 1, 2020 20:16
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) Type: Refactoring and other improvements Improvement of code and documentation that does not alter functionality.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants