Skip to content

Commit

Permalink
Fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dimakudosh authored and dimakudosh committed Sep 26, 2021
1 parent f26e930 commit 43acfdd
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installation

Compatibility
-------------
**pydfs-lineup-optimizer** works with following versions of python: Python: 3.3+
**pydfs-lineup-optimizer** works with following versions of python: Python: 3.8+

Installation
------------
Expand Down
3 changes: 3 additions & 0 deletions docs/usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,7 @@ It increases fantasy points for each player that wasn't used in the previous lin
It works cumulatively so fantasy points will be greater if the player wasn't used in the lineup multiple times.
After the player will be selected to lineup his points will be reset to the original value.
You can change this value for a specific player by setting `progressive_scale` property of Player or by adding `Progressive Scale` column to import csv.

.. code-block:: python
optimizer.set_fantasy_points_strategy(ProgressiveFantasyPointsStrategy(0.01)) # Set progressive strategy that increase player points by 1%
Expand All @@ -298,10 +299,12 @@ All of these lineups will be excluded from optimization and newly generated line
optimizer.print_statistic()
optimizer.export('export.csv')
Additional columns in csv
-------------------------

The optimizer can parse those additional columns that can be added to imported csv:

- Max Exposure
- Min Exposure
- Roster Order
Expand Down

0 comments on commit 43acfdd

Please sign in to comment.