Skip to content

[api-documenter] yaml validation error for static/instance methods with same name #1252

@Vitalius1

Description

@Vitalius1

When running the api-documenter on the api.json file of the @uifabric/utilities package I get this error thrown:
Screen Shot 2019-04-29 at 2 36 26 PM
When looking at the eventgroup.yml file generated I indeed see that they are the same:
Screen Shot 2019-04-29 at 2 38 00 PM

... upon further digging into the package itself I found that the issue is from the EventGroup class has 2 methods with the name of raise. The only difference is that one is public static and the other one is just public.

https://github.com/OfficeDev/office-ui-fabric-react/blob/a1947a24c401056a470abcaef37694ae1c8419ef/packages/utilities/src/EventGroup.ts#L75
https://github.com/OfficeDev/office-ui-fabric-react/blob/a1947a24c401056a470abcaef37694ae1c8419ef/packages/utilities/src/EventGroup.ts#L321

Is this something that is a @uifabric/utilities package issue that needs to be addressed or api-documenter needs somehow to take that into the account?

For reference, this is what the api.json file has for both methods:

Screen Shot 2019-04-29 at 2 46 55 PM
Screen Shot 2019-04-29 at 2 47 09 PM

... and the error is most likely is thrown by this line in the typescript.schema.json:
https://github.com/Microsoft/web-build-tools/blob/5935e8e3d166d25777c0bd9e187267c29f6eb627/apps/api-documenter/src/yaml/typescript.schema.json#L64

cc: @natalieethell

Metadata

Metadata

Assignees

No one assigned

    Labels

    ae-ambiguous-idsThis issue belongs to a set of bugs tracked by PetebugSomething isn't working as intended

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions