kivy / kivy/oscpy

Example code in ReadMe won't run.

Open
#76 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
114
Forks
26
PR merge metrics
No merged PRs in 30d

Description

The Readme contains some example code.

One example demonstrates that servers are also clients:

* It imports `time.sleep()` but never uses it. Meanwhile, it uses `time.time()` without importing it.
* It has a variable called `cont` which is never defined.
* It does a busy wait, which is not demonstrating a good way to use the API.
* It keeps appending True to a list (Why not just count?), but never popping it.
* ping takes parameters, but it isn't clear what they represent.
* pong doesn't use the *parameter. Rename it `_`.

One example demonstrates that async servers.
* It imports OSCThreadServer but uses OSCAsyncServer

One example demonstrates how Unicode is used.

* Uses OSCThreadServer without importing.
* Uses send_message() without the expected `osc.` prefix.

Contributor guide

Open the contributing guide

Research direction

Start in the README and run each of the reported Python examples. Check the server/client, async-server, and Unicode examples against their imports, variables, parameters, and API calls; done means the examples run without errors and clearly demonstrate the behavior described.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.