microsoft / microsoft/CLRInstrumentationEngine
Documentation and annotations on IInstructionFactory::CreateBranchInstruction is wrong.
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 102
- Forks
- 52
- Avg merge
- 13h 11m
- Merged PRs (30d)
- 6
Description
HRESULT CreateBranchInstruction([in] enum ILOrdinalOpcode opcode, [in] IInstruction* pBranchTarget, [out] IInstruction** ppInstruction); Uses an [in] annotation for pBranchTarget, indicating that it cannot be null, but we do accept null for that parameter.
It should be safe to just update the annotation and the documentation since we do not marshal this data across processes or machines.
Contributor guide
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 by locating the declaration and documentation for IInstructionFactory::CreateBranchInstruction and inspect the pBranchTarget parameter annotation. Update the annotation and accompanying documentation to reflect that null is accepted, then verify that both descriptions agree with the stated behavior; no specific file or test is named.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100