From f7d4966bc6e7d1a8282a1b4d6f9ea9a204621b2b Mon Sep 17 00:00:00 2001 From: galenbwill Date: Tue, 16 Aug 2022 12:41:13 -0400 Subject: Fix typos, clean up formatting in documentation.md --- .github/ISSUE_TEMPLATE/documentation.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md index 5138ef47..ec4a5bca 100644 --- a/.github/ISSUE_TEMPLATE/documentation.md +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -8,12 +8,17 @@ assignees: '' --- **Is this a general concept that needs to be documented or a specific API?** -Does this involve a specific API/set of APIs or a whole concept in Binary Ninja (i.e. BinaryViews, Basic Blocks, etc) + +_Describe whether this involves a specific API/set of APIs or a whole concept in Binary Ninja (i.e., BinaryViews, Basic Blocks, etc.)._ **What concept or API needs more documentation?** -Please provide a clear and concise description of the API or concept which is confusing or missing documentation. + +_Please provide a clear and concise description of the API or concept which is confusing or missing documentation._ **Is this documentation related to a specifi API?** -Decribe which API needs documentation. C++ or Python (The C API is not intended to be a documented interface) -**Are there any known examples of people using this API/concept? ** +_Describe which API needs documentation, C++ or Python. (Note: the C API is not intended to be a documented interface.)_ + +**Are there any known examples of people using this API/concept?** + +_Describe or link to any public examples for this, i.e., repositories or blog posts._ -- cgit v1.3.1