BNIL Syntax explainers in hover text

Open
#8,405 0 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
55/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Quiet
Tech stack
cpp

Research direction

Start with the BNIL overview linked in the issue and review the existing brief description strings for Comparisons, sx/zx, Size Specifiers, Variable Offsets, and macros. Then locate the UI hover-text entry point and make each documented syntax item show a concise explanation; done means all listed items have usable hover text.

Written by the indexing model from the issue text.

Description

Component: UI Effort: Trivial Impact: Medium UI: Graph UI: Linear

What is the feature you'd like to have?
Each of the documented "BNIL things" should have self-explaining hover-text explaining what it is in the UI: Comparisons, sx/zx, Size Specifiers, Variable Offsets, and each macro. The docs already have brief description strings that mostly should fit in a small popup.

Is your feature request related to a problem?
Very often the first question that gets asked about our ILs are the "weird" bits of syntax, hover tends to be where I see people looking first.

Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

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.

More from Vector35/binaryninja-api

All issues in Vector35/binaryninja-api

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.