Vector35 / Vector35/binaryninja-api
Improve documentation and fix type hint for `define_auto_symbol_and_var_or_function`
Open
Nobody has claimed this yet.
Effort: Trivial
Impact: Low
- Dominant language
- C++
- Stars
- 1.3k
- Forks
- 298
- Avg merge
- 5d 5h
- Merged PRs (30d)
- 19
Description
The documentation is incomplete for define_auto_symbol_and_var_or_function it needs to say that it creates a function/variable based on the symbol type. Additionally the type hint is wrong and should show Optional[Type] instead of Type
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Search for the define_auto_symbol_and_var_or_function entry point and inspect its documentation and type annotation. Update the documentation to explain that the symbol type determines whether a function or variable is created, and make the annotation show Optional[Type].
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 50/100