Updated docs #206
Open
Updated docs #206
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
koenvo
reviewed
Jul 29, 2023
| ### DataFactory | ||
|
|
||
| #### load | ||
| `kloppy.kloppy._providers.datafactory.load(event_data, event_types=None, coordinates=None, event_factory=None)` |
There was a problem hiding this comment.
Is it possible to generate event-data.md and tracking-data.md from code? And if not, please make sure the function call looks like kloppy.datafactory.load. We try to hide the _providers module from the end-users.
There was a problem hiding this comment.
It's not generated from code. And yes, good point. I'll update that.
koenvo
reviewed
Jul 29, 2023
| - [Metrica](#metrica) | ||
| - [Opta](#opta) | ||
| - [Sportec](#sportec) | ||
| - [SportsCode](#sportscode) |
There was a problem hiding this comment.
SportsCode isn't event data. It's a separate category.
There was a problem hiding this comment.
What do you recon this category should be called?
|
The new structure looks good to me. |
|
@UnravelSports can you give a status update? |
|
Status update: I have not done any more work on this, unfortunately. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi!
As per #205 I have made an initial attempt at improving some of the documentation. An overview of the changes are:
"coordinates"including the pitch dimensions, origin and orientation.I'm creating this initial Pull Request to see if I'm on the right track and to potentially discuss how to segment the docs going forward.