Skip to content

Commit

Permalink
Add docstring for phonenumber dataclass
Browse files Browse the repository at this point in the history
  • Loading branch information
amrit110 committed Nov 12, 2024
1 parent fcb1368 commit 231840b
Showing 1 changed file with 15 additions and 1 deletion.
16 changes: 15 additions & 1 deletion health_rec/api/data.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,21 @@


class PhoneNumber(BaseModel):
"""Phone number with metadata."""
"""Phone number with metadata.
Attributes
----------
number : str
The phone number.
type : Optional[str]
The type of the phone number, e.g., fax, toll-free, primary, secondary, etc.
name : Optional[str]
Any name associated with the phone number.
description : Optional[str]
The description of the phone number.
extension : Optional[str]
The extension of the phone number.
"""

number: str
type: Optional[str] = None
Expand Down

0 comments on commit 231840b

Please sign in to comment.