Review API docs in BI editor#517
Open
daneshk wants to merge 2 commits intoballerina-platform:masterfrom
Open
Conversation
daneshk
requested review from
TharmiganK,
lnash94 and
shafreenAnfar
as code owners
daneshk
requested review from
Copilot
and removed request for
TharmiganK,
lnash94 and
shafreenAnfar
There was a problem hiding this comment.
Pull Request Overview
This PR improves the API documentation for URL encoding and decoding functions by clarifying parameter descriptions and return value documentation.
- Enhanced parameter descriptions with more specific language and examples
- Simplified return value descriptions for better clarity
- Added concrete examples for the charset parameter (e.g., "UTF-8")
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #517 +/- ##
=========================================
Coverage 93.54% 93.54%
Complexity 10 10
=========================================
Files 6 6
Lines 31 31
Branches 7 7
=========================================
Hits 29 29
Partials 2 2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Purpose
Related issue: ballerina-platform/ballerina-library#8275
Examples
Checklist