ballerina-lang icon indicating copy to clipboard operation
ballerina-lang copied to clipboard

Support update documentation CA for included record params

Open KavinduZoysa opened this issue 1 year ago • 5 comments

Purpose

Fixes #42304

KavinduZoysa avatar May 27 '24 09:05 KavinduZoysa

Codecov Report

Attention: Patch coverage is 83.33333% with 1 line in your changes missing coverage. Please review.

Project coverage is 77.33%. Comparing base (2c23c00) to head (dbfdf45). Report is 139 commits behind head on master.

Files Patch % Lines
...angserver/command/docs/DocumentationGenerator.java 83.33% 0 Missing and 1 partial :warning:
Additional details and impacted files
@@            Coverage Diff             @@
##             master   #42809    +/-   ##
==========================================
  Coverage     77.33%   77.33%            
- Complexity    58483    58548    +65     
==========================================
  Files          3457     3460     +3     
  Lines        219824   219998   +174     
  Branches      28890    28912    +22     
==========================================
+ Hits         169996   170141   +145     
- Misses        40432    40452    +20     
- Partials       9396     9405     +9     

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar May 27 '24 14:05 codecov[bot]

For the scenario below, we are not getting the Update document code action for *ParamConfig config. Even the Document this code action does not add a description for *ParamConfig config. Shall we check the cause of that as well? Or maybe we can fix it with another issue as we will also have to change the Document this code action.

# Description.
#
# + id - parameter description  
# + value - parameter description
# + return - return value description
function logMsg(int id, int value, *ParamConfig config) returns int {
    return 0;
}

mindula avatar May 28 '24 05:05 mindula

For the scenario below, we are not getting the Update document code action for *ParamConfig config. Even the Document this code action does not add a description for *ParamConfig config. Shall we check the cause of that as well? Or maybe we can fix it with another issue as we will also have to change the Document this code action.

# Description.
#
# + id - parameter description  
# + value - parameter description
# + return - return value description
function logMsg(int id, int value, *ParamConfig config) returns int {
    return 0;
}

This is tracked with https://github.com/ballerina-platform/ballerina-lang/issues/42303, and fixed with this PR:

https://github.com/ballerina-platform/ballerina-lang/assets/59343084/47d202dd-2414-42fd-8b73-d68f800dc88f

As mentioned in my previous comment, we need to add the respective test cases.

nipunayf avatar May 28 '24 05:05 nipunayf

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

github-actions[bot] avatar Jun 13 '24 19:06 github-actions[bot]

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

github-actions[bot] avatar Jun 29 '24 19:06 github-actions[bot]

This PR has been open for more than 15 days with no activity. This will be closed in 3 days unless the stale label is removed or commented.

github-actions[bot] avatar Jul 16 '24 19:07 github-actions[bot]

I will address comments in a different PR.

KavinduZoysa avatar Aug 02 '24 12:08 KavinduZoysa