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

Documentation: Wrong class signatures #66

Closed
coal0 opened this issue Dec 11, 2017 · 2 comments
Closed

Documentation: Wrong class signatures #66

coal0 opened this issue Dec 11, 2017 · 2 comments

Comments

@coal0
Copy link
Contributor

coal0 commented Dec 11, 2017

I was taking a look at the docs for App and found the class signature is outdated:

class guizero.App(title="GUIzero", height=500, width=500, layout="auto", bgcolor=None)

The correct class signature is

__init__.py(self, title="guizero", width=500, height=500, layout="auto", bgcolor=None)
Source: https://github.com/lawsie/guizero/blob/master/guizero/App.py

(Note the capitalization: "GUIzero""guizero").
I guess this isn't a huge issue, but I got confused because some test cases were failing. I guess this should be fixed all at once in the 0.4 release? I don't know if this is true for other widgets too, but I'll take a look sometime soon.

This error persists in the Parameters section:

Parameter Data type Default Compulsory Description
title string "GUIzero" No The title displayed in the bar at the top of the window.
@lawsie
Copy link
Owner

lawsie commented Dec 12, 2017

Yeah, I'm in the process of updating all of the docs (which is fun!)

@coal0 coal0 closed this as completed Dec 13, 2017
@coal0
Copy link
Contributor Author

coal0 commented Dec 13, 2017

To be fixed.

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