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

[RFC][ENH] OWWidget: Input/output summary #2556

Merged
merged 18 commits into from
Nov 30, 2018

Conversation

ales-erjavec
Copy link
Contributor

@ales-erjavec ales-erjavec commented Aug 31, 2017

Issue

Provide a consistent widget input/output descriptions to the user.

Description of changes

Works on top of #2514

Add an input and output message areas in the widget's status bar.
The widget authors set the summaries using

self.info.set_input_summary("foo")
self.info.set_output_summary("bar")

for basic inline short descriptions. A more detailed (including rich text) summaries are also possible:

screen shot 2017-08-31 at 13 24 12

Ignore stylistic deficiencies in the last commit. Its flailing around to find some common 'description language'.

Includes
  • Code changes
  • Tests
  • Documentation

@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 4 times, most recently from f4220f2 to 3231d90 Compare September 5, 2017 15:16
@codecov-io
Copy link

codecov-io commented Sep 5, 2017

Codecov Report

Merging #2556 into master will increase coverage by 0.05%.
The diff coverage is 96.76%.

@@            Coverage Diff             @@
##           master    #2556      +/-   ##
==========================================
+ Coverage   83.17%   83.23%   +0.05%     
==========================================
  Files         362      362              
  Lines       63832    64088     +256     
==========================================
+ Hits        53094    53344     +250     
- Misses      10738    10744       +6

@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 2 times, most recently from 831a658 to a8d85ae Compare September 5, 2017 16:10
@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 6 times, most recently from e2caffb to fee6450 Compare September 21, 2017 15:23
@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 3 times, most recently from e5b07a0 to 3777d58 Compare October 2, 2017 12:57
@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 2 times, most recently from 12b2d6b to f79fd99 Compare December 29, 2017 08:34
@astaric
Copy link
Member

astaric commented Apr 17, 2018

@markotoplak, @BlazZupan, @janezd, this has been sitting here for too long.

If rebased, could it be included in the next release?

I/O Summaries
-------------

.. versionadded:: 3.7
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This line will probably have to updated. :)

@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 2 times, most recently from 332b65e to e1bf6c3 Compare July 30, 2018 09:10
@ales-erjavec ales-erjavec changed the title [RFC][WIP][ENH] OWWidget: Input/output summary [RFC][ENH] OWWidget: Input/output summary Jul 30, 2018
@ajdapretnar
Copy link
Contributor

This didn't make it into the 3.15.0 release, so where are we at?

@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 2 times, most recently from c4adb6d to 3024ad2 Compare September 11, 2018 09:50
@ajdapretnar
Copy link
Contributor

@BlazZupan Can we merge this before 3.16 or at least decide what to do with it? @lanzagar

@BlazZupan
Copy link
Contributor

This looks really cool, @ales-erjavec can you please resolve conflicts and then we merge.

:alt: Inline status bar summary

Predefined constants indicating no input/output are available as
``self.info.NoInput`` and ``self.info.NoOutput`` respecively
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

respectively

@BlazZupan
Copy link
Contributor

Once merged, this functionality would also require a note in a widget development documentation. @ales-erjavec, can you please add an entry there as well.

@ales-erjavec ales-erjavec force-pushed the widget-status-bar-extra-info branch 2 times, most recently from c63b07a to 60b74f7 Compare November 30, 2018 10:28
@janezd janezd merged commit d2a8345 into biolab:master Nov 30, 2018
@janezd janezd mentioned this pull request Dec 26, 2018
1 task
@ales-erjavec ales-erjavec deleted the widget-status-bar-extra-info branch May 20, 2019 11:31
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.

7 participants