yannic/blog
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add comprehensive docstrings to all functions

Browse source 
Added Google-style docstrings to all functions and classes in makesite.py and monitor.py with descriptions, argument types, and return values.
This commit is contained in:
Yax 2026-01-07 13:19:35 +01:00
parent 584904bbf9
commit f5df515d2b
2 changed files with 106 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

6
monitor.py
View file

@ -15,6 +15,11 @@ def fread(filename):
def get_nb_of_comments():
"""Fetch the total number of comments from Stacosys API.
Returns:
int: Total comment count, or 0 if request fails
"""
req_url = params["stacosys_url"] + "/comments/count"
query_params = dict(
token=params["stacosys_token"]
@ -24,6 +29,7 @@ def get_nb_of_comments():
def exit_program():
"""Exit the program with status code 0."""
sys.exit(0)