Skip to content

Commit 2bc0257

Browse files
committed
Adds module docstrings for compressor and parse modules
Improves code documentation by adding comprehensive module-level docstrings that describe the purpose and functionality of each module. Includes licensing information and copyright details for better code attribution and legal compliance.
1 parent 9c95caa commit 2bc0257

File tree

2 files changed

+25
-0
lines changed

2 files changed

+25
-0
lines changed

resources/compressor.py

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,16 @@
1+
"""
2+
resources/compressor.py
3+
-----------------------
4+
5+
Implements a high level config extractor to extract config from
6+
compressor.settings.txt and replace placeholders with actual values.
7+
It also reads README.md and CHANGELOG.md files to include their contents
8+
in the final configuration for automatic releases.
9+
10+
:license: MIT - see LICENSE for more details
11+
:copyright: (c) 2025-present AARUSH MASTER
12+
"""
13+
114
import argparse
215
import re
316
from pathlib import Path

resources/parse.py

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1+
"""
2+
resources/prase.py
3+
------------------
4+
5+
Implements a script to parse a JSON schema file and extract
6+
release information such as title, description, and tag.
7+
It encodes the description in base64 for use in GitHub Actions.
8+
9+
:license: MIT - see LICENSE for more details
10+
:copyright: (c) 2025-present AARUSH MASTER
11+
"""
12+
113
import base64
214
import orjson
315
import os

0 commit comments

Comments
 (0)