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

Added docstring documentation to SpeakActivity class and poll_accelerometer function #31

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

mebinthattil
Copy link

No description provided.

Copy link
Contributor

@quozl quozl left a comment

Choose a reason for hiding this comment

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

We have hundreds of activities with the activity class not documented in this way, so it doesn't make sense to add this documentation to just one activity. The text doesn't say anything that isn't obvious, almost as if it is automatically generated.

Your text in the accelerometer check makes the assertion that only tablets have accelerometers, and I worked really hard to put an accelerometer in a laptop.

Your commit messages do not follow our guidance.

@mebinthattil
Copy link
Author

Noted, shall make future commits accordingly.

@quozl
Copy link
Contributor

quozl commented Feb 4, 2025

You don't need to wait until future commits, you can use git rebase -i to reword these ones and then force push. https://github.com/sugarlabs/sugar-docs/blob/master/src/contributing.md#making-commits is our guidance on wording.

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

Successfully merging this pull request may close these issues.

2 participants