[Bug]: Incorrect document generated for a record with multiple included records

[TharmiganK]

Description

When we have included multiple private records in another record and call bal doc to generate the document, the generated document has two rest parameter types which are inferred from the private included records. But there should be only one rest parameter.

Steps to Reproduce

Sample Ballerina code:

type Record1 record {
    int a;
    string b;
};

type Record2 record {
    boolean c;
    string[] d;
};

public type Record record {
    *Record2;
    *Record1;
    float e;
};

The Generated record documentation:

Affected Version(s)

Ballerina SwanLake Update 8

OS, DB, other environment details and versions

No response

Related area

-> API Docs

Related issue(s) (optional)

No response

Suggested label(s) (optional)

No response

Suggested assignee(s) (optional)

No response

[TharmiganK]

Notice an inconsistency in showing rest field

• The rest parameter is not documented for inclusive record definition:

  public type OpenRecord record { int a; string b; };

• The rest parameter is shown when we have a exclusive record definition with a rest parameter. But there are inconsistencies when the rest field is another type

public type ClosedRecordWithAnyData record {| int a; string b; anydata...; |};
public type ClosedRecordWithString record {| int a; string b; string...; |};
public type PublicRecord record {| int a; string b; record {boolean c; string[] d;}...; |};
public type PublicRecord record {| int a; string b; Record...; // public |};

We should decide on a proper way to document the rest field for a record type. Having anydata... does not make much sense for a included record. Having anydata... Rest Field is fine but can we do better?

CC: @MaryamZi @SasinduDilshara @sm1990