Ensure the fixture method of Footy returns a Fixture object (#14). - Githubissues

FootyStats / footy

Football Statistics

BSD 3-Clause "New" or "Revised" License

3 stars 0 forks source link

Ensure the fixture method of Footy returns a Fixture object (#14). #31

Closed dallinb closed 4 years ago

dallinb commented 4 years ago

Overview

This PR ensures that instead of a complicated dictionary being returned by the fixture method of the Footy class, a Fixture object is instead. I have updated all the tests, the docstrings and the back ground Jupyter notebook. The method will always return a Fixture object, but if there is enough data to calculate the probabilities, it will enrich the object with those details.

Available Previews

Package documentation https://github.com/FootyStats/footy/blob/feature/Issue14-Fixture-Object/docs/index.md#welcome-to-footys-documentation
Background Jupyter Notebook https://github.com/FootyStats/footy/blob/feature/Issue14-Fixture-Object/background.ipynb

Possible Areas of Contention

I use get/set methods, I can convert to the more Java like approach if preferred.

Issues Fixed

Fixes #14