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

Include example screenshots in documentation #65

Open
evnb opened this issue Jul 22, 2020 · 2 comments
Open

Include example screenshots in documentation #65

evnb opened this issue Jul 22, 2020 · 2 comments
Labels

Comments

@evnb
Copy link

evnb commented Jul 22, 2020

As a prospective user of ttkwidgets, it would be very helpful to have example screenshots to see how these widgets look, and if they align with my desired functionality. I imagine I'm not alone in this.

Not a priority but it would be nice :)

Here is an example of this in another set of widgets: https://github.com/slightlynybbled/tk_tools

@WinEunuuchs2Unix
Copy link

@envb I agree wholeheartedly but it seems most python documentation doesn't have screenshots. That said here is a screenshot for ttkwidgets' class CheckboxTreeview():

CheckboxTreeview selections

I took the screenshot because I think the "checked" checkbox image is too subtle. On some of my monitors it is difficult to differentiate from the "unchecked" checkbox image.

My current work around is to set the "checked" background color to light steel blue 1.

I don't know much about Gimp but I'm thinking of trying to set colors to checkbox images such that:

  • "checked" is a green checkmark ✔
  • "unchecked" is a red cross ❌
  • "tristate" is a blue square 🟦

Not to sure if this will be successful.

Too make a long story short screenshots in the first place would help you see what you will be getting. In the second place it makes it easier for people to discuss the widget and discuss changes to it.

@RedFantom
Copy link
Member

This is certainly something to be considered. However, personally, I would very much prefer if the screenshots could be taken by a script, so there would be no need to manually recreate them every time a widget changes. However, some widgets offer advanced functionality, so that would require adding some sort of action system before taking the screenshots. This makes it quite complicated to do, so that's why there currently are no screenshots included.

In the meantime, I'm not opposed to adding screenshots for each widget, but it isn't a priority right now. The example scripts give the best impression of what the widgets can do, and I recommend giving them a go if you are interested in a particular widget.

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

No branches or pull requests

3 participants