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

Add functionality to display the description of the component parameters #200

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

Conversation

rarescodemart
Copy link

@rarescodemart rarescodemart commented Dec 6, 2022

Description

Hello!

I work for The Virtual Brain project and we are building an extension for Xircuits. In this PR we have added info buttons for the component parameters and would like to ask you whether you would find it useful to merge this into your original code.

The outcome can be seen in the screenshot below.

image

Pull Request Type

  • Xircuits Core (Jupyterlab Related changes)
  • Xircuits Canvas (Custom RD Related changes)
  • Xircuits Component Library
  • Xircuits Project Template
  • Testing Automation
  • Documentation
  • Others (Please Specify)

Type of Change

  • New feature (non-breaking change which adds functionality)
  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

Tests

I created a json file specific for the KerasTransferLearningModel component which is present in this PR. It contains the descriptions for each parameter. If there is no description we do not show the info button next to the parameter.

You can test this functionality by dragging the KerasTransferLearningModel component into the Xircuits diagram and pressing any of the info buttons near the component parameters.

Tested on?

  • Windows
  • Linux Ubuntu
  • Centos
  • Mac
  • Others (State here -> xxx )

@rarescodemart rarescodemart changed the title WID-100: add functionality to display the description of the component arguments Add functionality to display the description of the component parameters Dec 6, 2022
@MFA-X-AI
Copy link
Member

Hey, thanks for the PR! Looks like a really neat feature, hope to get integrated in soon.
Just wanted to give you guys a heads-up that the review will take some time, first we need to get #193 merged first, then this one. It'll likely introduce conflicts since it's a big change, but we'll do our best to help.

@rarescodemart rarescodemart force-pushed the WID-100A branch 3 times, most recently from 1960331 to d524fdc Compare December 19, 2022 11:24
@popaula937 popaula937 force-pushed the WID-100A branch 2 times, most recently from 5cb44e0 to bf58b01 Compare March 14, 2023 14:57
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.

3 participants