docs: add original_year to album docstring

MoeMusic · Oct 12, 2022 · b2def8f · b2def8f
1 parent 97b35d4
commit b2def8f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/developers/api/core.rst b/docs/developers/api/core.rst
@@ -27,7 +27,7 @@ Library
 
 .. automodule:: moe.library
    :members:
-   :exclude-members: cache_ok, path, year, genre
+   :exclude-members: cache_ok, path, year, genre, original_year
    :show-inheritance:
 
 

diff --git a/moe/library/album.py b/moe/library/album.py
@@ -93,6 +93,8 @@ class Album(LibItem, SABase):
         label (str): Album release label.
         media (str): Album release format (e.g. CD, Digital, etc.)
         original_date (datetime.date): Date of the original release of the album.
+        original_year (int): Album original release year. Note, this field is read-only.
+            Set ``original_date`` instead.
         path (pathlib.Path): Filesystem path of the album directory.
         title (str)
         tracks (list[Track]): Album's corresponding tracks.