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

Add Plugin base classes APIs to readthedocs #2736

Merged
merged 5 commits into from
Dec 3, 2020

Conversation

forslund
Copy link
Collaborator

Description

This updates the docstrings for the base classes for the pluggable systems to provide more of the information needed for creating plugins. Plugins are also added to the API documentation.

I'd very much appreciate improvementson the docstrings I've suggested here.

How to test

run make html in the docs folder and check that the resulting plugin documentation looks good.

Contributor license agreement signed?

CLA [ Yes ]

@devops-mycroft devops-mycroft added the CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) label Oct 26, 2020
@forslund forslund added Type: Refactoring and other improvements Improvement of code and documentation that does not alter functionality. and removed CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) labels Oct 26, 2020
@devs-mycroft devs-mycroft added the CLA: Yes Contributor License Agreement exists (see https://github.com/MycroftAI/contributors) label Oct 26, 2020
@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

Copy link
Contributor

@krisgesling krisgesling left a comment

Choose a reason for hiding this comment

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

Hey Ake, this is such a huge improvement, thankyou!!!

A bunch of comments but all little things. Definitely push back if I've misunderstood anything.

doc/index.rst Outdated Show resolved Hide resolved
doc/source/plugins.rst Outdated Show resolved Hide resolved
mycroft/audio/services/__init__.py Outdated Show resolved Hide resolved
mycroft/audio/services/__init__.py Outdated Show resolved Hide resolved
mycroft/audio/services/__init__.py Outdated Show resolved Hide resolved
mycroft/stt/__init__.py Outdated Show resolved Hide resolved
mycroft/stt/__init__.py Outdated Show resolved Hide resolved
mycroft/tts/tts.py Outdated Show resolved Hide resolved
mycroft/tts/tts.py Outdated Show resolved Hide resolved
mycroft/tts/tts.py Outdated Show resolved Hide resolved
@forslund
Copy link
Collaborator Author

I've updated with the suggested texts (in all cases except one) I tried to reword the index page. but might need some more tlc.

@devops-mycroft
Copy link

Voight Kampff Integration Test Failed (Results)

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@krisgesling
Copy link
Contributor

Is there a commit missing here, I'm seeing a few unchanged.

Also small nitpick - we don't seem to be consistent with the argument type being before or after the colon, eg:

some_arg (type): description
some_arg: (type) description

@forslund
Copy link
Collaborator Author

forslund commented Nov 4, 2020

I'll look over the argument type changes. Likely I've gotten confused over time and mix up the order. Can you give an example of unchanged?

@forslund
Copy link
Collaborator Author

forslund commented Nov 4, 2020

Now I see what you mean. I seem to have missed most of your comments. sorry about that

@devops-mycroft
Copy link

Voight Kampff Integration Test Succeeded (Results)

@forslund
Copy link
Collaborator Author

forslund commented Nov 9, 2020

I think this is once more ready for review. All of the comments should be handled now...I think

Copy link
Contributor

@krisgesling krisgesling left a comment

Choose a reason for hiding this comment

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

Looks fantastic!

Thanks!

@krisgesling krisgesling merged commit 6f8bae6 into MycroftAI:dev Dec 3, 2020
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.

4 participants