Skip to content

Commit 97aa65e

Browse files
committed
Enhance module-level docstring in P2Pool API initializer with detailed class, exception, ORM model, and helper descriptions for improved clarity and documentation.
1 parent befe4cd commit 97aa65e

File tree

1 file changed

+36
-1
lines changed

1 file changed

+36
-1
lines changed

p2pool/__init__.py

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,42 @@
11
"""
22
P2Pool API module initializer.
33
4-
This module provides the `P2PoolAPI` object to interact with the P2Pool API.
4+
This module provides the `P2PoolAPI` object to interact with the P2Pool API and store collected data in a database.
5+
It includes:
6+
7+
Classes:
8+
- P2PoolAPI: A class for interacting with P2Pool miner API data sources.
9+
- P2PoolDatabase: A class for interacting with the P2Pool database.
10+
11+
Exceptions:
12+
- P2PoolAPIError: General error with the P2Pool API.
13+
- P2PoolConnectionError: Connection error with the P2Pool API.
14+
- P2PoolDatabaseError: Database error with the P2Pool API.
15+
16+
ORM Models:
17+
- Console: ORM model for the local console endpoint.
18+
- P2P: ORM model for the local P2P endpoint.
19+
- Stratum: ORM model for the local stratum endpoint.
20+
- NetworkStats: ORM model for the network stats endpoint.
21+
- PoolBlocks: ORM model for the pool blocks endpoint.
22+
- PoolStats: ORM model for the pool stats endpoint.
23+
- StatsMod: ORM model for the stats mod endpoint.
24+
25+
Helpers:
26+
- _local_console_endpoint: API endpoint for local console.
27+
- _local_p2p_endpoint: API endpoint for local P2P.
28+
- _local_stratum_endpoint: API endpoint for local stratum.
29+
- _network_stats_endpoint: API endpoint for network stats.
30+
- _pool_blocks_endpoint: API endpoint for pool blocks.
31+
- _pool_stats_endpoint: API endpoint for pool stats.
32+
- _stats_mod_endpoint: API endpoint for stats mod.
33+
- _local_console_table_name: Table name for local console.
34+
- _local_p2p_table_name: Table name for local P2P.
35+
- _local_stratum_table_name: Table name for local stratum.
36+
- _network_stats_table_name: Table name for network stats.
37+
- _pool_blocks_table_name: Table name for pool blocks.
38+
- _pool_stats_table_name: Table name for pool stats.
39+
- _stats_mod_table_name: Table name for stats mod.
540
"""
641

742
# // TODO: Test recent changes to the module.

0 commit comments

Comments
 (0)