biolab / biolab/orange-widget-base

Visual settings need to be documented

Open
#224 1 comment 0 reactions 0 assignees View on GitHub
Dominant language
Python
Stars
28
Forks
62
PR merge metrics
No merged PRs in 30d

Description

##### Orange version

3.34.0

##### Expected behavior
The documentation should contain explanations of the available visual settings for all widgets.

##### Actual behavior
There does not seem to be any documentation of the visual settings for the widgets – they are not always self-explanatory. E g, in the Line Plot widget there are settings for “Range” and “Selected range”. I thought these might adjust the boundaries for the Range in the Display settings, but apparently they represent the percentage of the grey scale value of the rendered Range. A pop-up would be fine.

##### Steps to reproduce the behavior
Go through the documentation pages at https://orangedatamining.com/widget-catalog/, notice the visual settings are not mentioned.
Open a widget and click the “Set visual settings” [a little redundant, eh?] button, hover over the settings, note no popups appear.

##### Additional info (worksheets, data, screenshots, ...)

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the widget-catalog pages and the Line Plot widget's “Set visual settings” controls, especially “Range” and “Selected range.” Document what the visual settings mean for the widgets, or add the suggested explanatory pop-ups; the widget documentation should no longer omit these settings.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.