Vector35 / Vector35/binaryninja-api
document short_name raw_name full_name
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
In the important concepts documentation we should add a section about the different type of names and how they are used.
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
Start in the important concepts documentation and identify where a section on short_name, raw_name, and full_name belongs. Document the distinctions between these names and how each is used; done means the section clearly covers all three concepts and their usage.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100