ARMmbed / ARMmbed/uvisor

Ambiguity in ACL Documentation

Open
#483 4 comments 0 reactions 0 assignees View on GitHub
mirrored
Dominant language
C
Stars
135
Forks
72
PR merge metrics
No merged PRs in 30d

Description

In https://github.com/ARMmbed/uvisor/blob/master/docs/lib/API.md
`acl_list` is List of ACLs for the module

However, the the parameter is supposed to be ACLs for peripherals/IRQs

Contributor guide

Open the contributing guide

Research direction

Open docs/lib/API.md and locate the acl_list parameter description. Confirm its meaning against the surrounding ACL API documentation, then clarify that it refers to ACLs for peripherals and IRQs rather than ACLs for the module. Done means the parameter description is unambiguous and consistent with the API.

Written by the indexing model from the issue text.

Assessment

Tech stack
c
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.