add short docstring to top of optimizer module

open-spaced-repetition · Jan 24, 2025 · 153862e · 153862e
1 parent ec7d801
commit 153862e
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/fsrs/optimizer.py b/fsrs/optimizer.py
@@ -1,3 +1,10 @@
+"""
+fsrs.optimizer
+---------
+
+This module defines the optional Optimizer class.
+"""
+
 from .fsrs import Card, ReviewLog, Scheduler, Rating, State, DEFAULT_PARAMETERS
 import math
 from datetime import datetime