Skip to content

Commit

Permalink
Modified docstrings to be more descriptive
Browse files Browse the repository at this point in the history
  • Loading branch information
MinhPhan8803 committed Oct 31, 2022
1 parent 4212ea3 commit fdbc9e2
Showing 1 changed file with 13 additions and 2 deletions.
15 changes: 13 additions & 2 deletions src/backend/app.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,14 @@ def mainpage():


def mainpage_get(mainpage_obj: MainPage, args: MultiDict):
"""Helper for mainpage get requests"""
"""
Helper for mainpage get requests
Actions that use get requests:
- Searching apartments
- Populating the mainpage with apartments
- Getting reviews of an apartment
- Getting pictures of an apartment
"""
action_type = namedtuple(
"action_type", ["is_search", "is_populate", "is_review", "is_pictures"]
)
Expand Down Expand Up @@ -111,7 +118,11 @@ def mainpage_get(mainpage_obj: MainPage, args: MultiDict):


def mainpage_post(mainpage_obj: MainPage):
"""Helper for mainpage post requests"""
"""
Helper for mainpage post requests
Actions that use post request:
- Writing a review to an apartment
"""
json_form = request.get_json(force=True)

if isinstance(json_form, dict):
Expand Down

3 comments on commit fdbc9e2

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCover
TOTAL2320100%

Tests Skipped Failures Errors Time
44 0 💤 0 ❌ 0 🔥 0.617s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCover
TOTAL2320100%

Tests Skipped Failures Errors Time
44 0 💤 0 ❌ 0 🔥 0.644s ⏱️

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCover
TOTAL2320100%

Tests Skipped Failures Errors Time
44 0 💤 0 ❌ 0 🔥 1.101s ⏱️

Please sign in to comment.