search

ballerina-platform / ballerina-central

Ballerina Central Website
Apache License 2.0
104 stars 1 forks source link

Broken Link in "Lang.Error" Module in Swan Lake API Docs #165

Open praneesha opened 4 years ago

praneesha commented 4 years ago

Description: The "DetailType" link[1] is broken in [2].

Screenshot 2020-07-28 at 18 17 19

[1] https://ballerina.io/swan-lake/learn/api-docs/ballerina/lang.error/records/DetailType.html [2] https://ballerina.io/swan-lake/learn/api-docs/ballerina/lang.error/functions.html

Steps to reproduce:

Affected Versions:

OS, DB, other environment details and versions:

Related Issues (optional):

Suggested Labels (optional):

Suggested Assignees (optional):

rdhananjaya commented 4 years ago

I think this should be pointing to the doc of [3] because DetailType is an alias to public type Detail. This is a common way of defining @typeParams in langlib modules.

[3] - https://github.com/ballerina-platform/ballerina-lang/blob/d6d7a1ed2e6b12c75d263de3a35f7c6473ad04fe/langlib/lang.error/src/main/ballerina/src/lang.error/error.bal#L18

shehan360 commented 4 years ago

This happens due to the DetailType typedefinition not containing the PUBLIC flag in its flagset.

Screenshot from 2020-08-11 16-57-25

rdhananjaya commented 4 years ago

@praneesha @shehan360 @hasithaa @hevayo Maybe we need to render the documentation of @typeparams to solve this.

shehan360 commented 3 years ago

This issue is blocked due to : https://github.com/ballerina-platform/ballerina-lang/issues/31063