Vector35 / Vector35/binaryninja-api

Tooltips showing Python API arguments should stay visible for longer

Open
#3,467 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Component: UI Effort: Low Impact: Low UI: Python Console
Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

Description

What is the feature you'd like to have?
When you're typing something in the Python console, it will sometimes helpfully show you, in a tooltip, what the arguments are to the API you're trying to call. The problem is, as soon as you start typing the arguments, the tooltip goes away and you can't see it anymore. I would like for the tooltip to stay visible until you're done filling in the function call (basically, until end-paren is typed) so that users can see what else they need to add to the function call at a glance.

Is your feature request related to a problem?
See above.

Are any alternative solutions acceptable?
Any solution that makes the arguments to the current API being used visible is acceptable. The tooltip already exists and works well, but if there's any other considerations that mean a different solution is better, by all means do that instead.

Contributor guide

No contributing guide indexed for this repository

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

Start at the Python console and inspect the existing API-argument tooltip behavior while typing a function call. Confirm when the tooltip currently disappears, then verify that the current call’s arguments remain visible through argument entry and disappear by the closing parenthesis.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
devtools
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.