Skip to content

Commit

Permalink
docs sphinx: subscriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
MalikAza committed May 23, 2024
1 parent 9c0624f commit 6e63400
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Welcome to pyZUnivers's documentation!
vortex
user
tickets
subscription

Indices and tables
==================
Expand Down
5 changes: 5 additions & 0 deletions docs/source/subscription.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
subscription
============

.. automodule:: pyZUnivers.subscription
:members:
7 changes: 7 additions & 0 deletions pyZUnivers/subscription.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,13 @@
from datetime import datetime

class Subscription:
"""
Represents a subscription with a begin and end date.
Attributes:
begin (datetime): The begin date of the subscription.
end (datetime): The end date of the subscription.
"""

def __init__(self, payload) -> None:
begin_date_format = get_correct_datetime_format(payload["beginDate"])
Expand Down

0 comments on commit 6e63400

Please sign in to comment.