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

Minor changes to documentation #2

Open
MarkTheGoose opened this issue Feb 1, 2019 · 1 comment
Open

Minor changes to documentation #2

MarkTheGoose opened this issue Feb 1, 2019 · 1 comment

Comments

@MarkTheGoose
Copy link

Excellent and useful tool, thank you.

In README.md, you might consider making the statement:

witty = wittyPy.WittyPi('path/to/wittyPi/Software')

slightly clearer, it caught me out until I figurered that it's a relative or absolute path statement. Mine ended up as

witty = wittyPy.WittyPi('/home/pi/wittyPi/')

which needed the '/' on both ends. I assume that if I was using the home directory '/home/pi' to run Python, then I could just use 'wittyPi/' as the path, but still with the '/' on the end.
Also, it would be good to make it clear that it's for Python3, as Raspbian still defaults to Python2.7

Finally, on your Guide page: http://docs.elpunkt.eu/wittyPy/guide.html
You could again be clearer with the path statement (as above) and there is an error in line 12

The example you give is:

print(witty.next_startup)

which should be:

print(witty.next_start)

@MarkTheGoose MarkTheGoose changed the title Minors changes to documentation Minor changes to documentation Feb 1, 2019
@benjaminfuchs
Copy link

I would suggest to use "os.path.join" here instead of "+":
https://github.com/elpunkt/wittyPy/blob/master/wittyPy/wittyPy.py#L45

Than it works with and without "/" at the end.

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

No branches or pull requests

2 participants