JOSS Review: API documentation gaps

[melund]

the auto-generated API docs cover the Game class and vizsualization functions. But not other things like data parsers, event types (ShotEvent, PassEvent etc. ) or utility funcs. A new user who wants to work with the event objects would need to read the source code. I would suggest expanding the API docs to cover the public classes and tracking data schema methods like get_covered_distance etc. Since these are the main ways a user interact with the package after loading data.

It don't think it ha be very exhaustive. Just the methods and shown in the examples would be fine.

This also not a blocker for the review, but more a suggestion which stumbled on.

openjournals/joss-reviews#10223

[Alek050]

Hi @melund,

Thanks for the suggestion. I added auto-api docs for tracking data and event data including its methods. I also added them for the loading in different datasources.

I choose not to add docs for ShotEvent and other events since I plan to remove it from from the package in the future. Although the functionalities will be available in other places of the package, I'd rather not have too many users rely on it because of that for now.