Skip to content

Fix rm.display() documentation in the readme #7

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.

Sign up for GitHub

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

Open
Eeems wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Fix rm.display() documentation in the readme #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,12 +129,12 @@ rm.timeout = 32
rm.fontsize = 24
```

When you run the `display` function, carta will wait on any input being given **OR** the timeout being reached. When it's done this, it will return a `dict` object with the input given.
When you run the `display` function, carta will wait on any input being given **OR** the timeout being reached. When it's done this, it will return a `tuple` with the input given.

```python
clicked = rm.display()

print(clicked) # {"<id>": True}
print(clicked) # ("<id>", True)
```

If it's a `button` that has been pressed it will return `True` as the value, if anything else has been given it will use that specific input (for example, from the keyboard) as the value.
Expand Down