Review API docs in BI editor

[daneshk]

Purpose

Related issue: ballerina-platform/ballerina-library#8275

Examples

Checklist

• Linked to an issue
• Updated the changelog
• Added tests
• Updated the spec
• Checked native-image compatibility

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 81.67%. Comparing base (8da2944) to head (fba689c).
⚠️ Report is 20 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff            @@
##             master    #1367   +/-   ##
=========================================
  Coverage     81.67%   81.67%           
  Complexity       81       81           
=========================================
  Files             8        8           
  Lines           562      562           
  Branches        114      114           
=========================================
  Hits            459      459           
  Misses           76       76           
  Partials         27       27           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[Copilot]

Pull Request Overview

This PR improves API documentation across the log module by enhancing clarity and consistency of docstrings and comments. The changes focus on making documentation more descriptive and following consistent formatting patterns.

• Enhanced docstring descriptions to be more specific and informative
• Improved consistency in documentation formatting and style
• Added clarifications for function parameters and return values

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
ballerina/natives.bal	Updated docstrings for types, enums, functions, and configurable variables to improve clarity and consistency
ballerina/log_errors.bal	Enhanced error type documentation to be more specific

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud