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

Updated Paint Data widget documentation #6977

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

borondics
Copy link
Member

Issue
Description of changes

Added new screenshots and modified the text accordingly.

I'm not a fan of the example though. It talks more about the clustering than Paint Data itself and I think it is not easy to see what the difference between k-means and hierarchical clustering is in this case with this layout. In any case, I'll leave it as is for now, with an updated image.

Includes
  • Code changes
  • Tests
  • Documentation

Copy link

codecov bot commented Jan 5, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.47%. Comparing base (0ce81e5) to head (fbef94d).

Additional details and impacted files
@@           Coverage Diff           @@
##           master    #6977   +/-   ##
=======================================
  Coverage   88.47%   88.47%           
=======================================
  Files         332      332           
  Lines       73287    73287           
=======================================
  Hits        64841    64841           
  Misses       8446     8446           

@markotoplak
Copy link
Member

markotoplak commented Jan 9, 2025

The images are too big (in file size, as in KB) for what they are for. They are made in retina resolution, which is probably unnecessary for the docs. We try to keep the cumulative help size as small as possible.

Also, keep widgets as small as possible while still showing the interface nicely. This allows users to use smaller help windows.

@markotoplak
Copy link
Member

@borondics, we discussed this in the lab. So we will allow retina images, BUT we won't allow any image resizing. Therefore, screenshots should be added in exactly the same size as they were taken, and any necessary resizing should go into the .md file (where we have to somehow specify that retina images are shown in 50% scale).

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

Successfully merging this pull request may close these issues.

2 participants