st-tech / st-tech/ppf-contact-solver

[Feature] better explanation for parameters on hover

Open
#40 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement queued
Dominant language
Python
Stars
4.5k
Forks
334
PR merge metrics
No merged PRs in 30d

Description

Motivation

More clear explanation to the everyday user.

Proposal

currently, when hovering over parameters for materials, it just says the property's name without providing any explanation, which isn't useful to the everyday user who isn't a physics engineer.

A simple explanation of what each parameter does on hover would be useful (as well as, if possible, what it does at higher vs lower values.

Alternatives Considered

No response

Additional Context

No response

Contribution Agreement
  • I confirm that any code, patches, scripts, attachments, or other copyrightable material I include in this issue may be used, reproduced, modified, and distributed by this project under the Apache License 2.0 or as otherwise described in CONTRIBUTING.md.
  • This is a feature request from the community (please provide a reference below).
Community Reference

No response

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No file, test, or entry point is named in the issue. Start by locating the material-parameter hover behavior and identifying which parameters need explanations; done means each relevant tooltip explains the parameter and, where possible, the effect of higher and lower values.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.