Skip to content

Commit

Permalink
More docstrings!
Browse files Browse the repository at this point in the history
  • Loading branch information
pkhalaj committed May 16, 2024
1 parent 9ef3340 commit c75d270
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 2 deletions.
10 changes: 9 additions & 1 deletion trolldb/tests/tests_api/test_api.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,12 @@
"""Documentation to be added!"""
"""Tests for the API server.
Note:
The functionalities of the API server is not mocked! For the tests herein an actual API server will be running in a
separate process. Moreover, a MongoDB instance is run with databases which are pre-filled with random data having
similar characteristics to the real data. Actual requests will be sent to the API and the results will be asserted
against expectations.
"""

import pytest
from fastapi import status

Expand Down
8 changes: 7 additions & 1 deletion trolldb/tests/tests_database/test_mongodb.py
Original file line number Diff line number Diff line change
@@ -1,4 +1,10 @@
"""Direct tests for `mongodb` module without an API server connection."""
"""Direct tests for :obj:`trolldb.database.mongodb` module without an API server connection.
Note:
The functionalities of the MongoDB client is not mocked! For the tests herein an actual MongoDB instance will be
run. It includes databases which are pre-filled with random data having similar characteristics to the real data.
Actual calls will be made to the running MongoDB instance via the client.
"""

import errno
import time
Expand Down

0 comments on commit c75d270

Please sign in to comment.