Skip to content

Commit b9a7b67

Browse files
actions-useractions-user
committed
docs: update codeboarding documentation
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 6 - JSON files created/updated: 7 - Documentation directory: .codeboarding/ - JSON directory: .codeboarding/ - Output format: .rst - Repository analyzed: https://github.com/CodeBoarding/praw - Source branch: main - Target branch: main 🤖 This commit was automatically generated by the CodeBoarding documentation update workflow.
1 parent 59f2832 commit b9a7b67

7 files changed

Lines changed: 32 additions & 202 deletions

File tree

‎.codeboarding/Configuration_Manager.json‎

Lines changed: 0 additions & 93 deletions
This file was deleted.

‎.codeboarding/Configuration_Manager.rst‎

Lines changed: 0 additions & 68 deletions
This file was deleted.

‎.codeboarding/Listing_Streaming.json‎

Lines changed: 4 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -11,20 +11,7 @@
1111
"reference_start_line": 13,
1212
"reference_end_line": 34
1313
}
14-
],
15-
"assigned_files": [
16-
"praw/models/listing/__init__.py",
17-
"praw/models/listing/domain.py",
18-
"praw/models/listing/listing.py",
19-
"praw/models/listing/generator.py",
20-
"praw/models/listing/mixins/__init__.py",
21-
"praw/models/listing/mixins/submission.py",
22-
"praw/models/listing/mixins/base.py",
23-
"praw/models/listing/mixins/subreddit.py",
24-
"praw/models/listing/mixins/redditor.py",
25-
"praw/models/listing/mixins/rising.py"
26-
],
27-
"can_expand": true
14+
]
2815
},
2916
{
3017
"name": "praw.Reddit",
@@ -36,9 +23,7 @@
3623
"reference_start_line": 57,
3724
"reference_end_line": 901
3825
}
39-
],
40-
"assigned_files": [],
41-
"can_expand": true
26+
]
4227
},
4328
{
4429
"name": "praw.models",
@@ -50,23 +35,12 @@
5035
"reference_start_line": null,
5136
"reference_end_line": null
5237
}
53-
],
54-
"assigned_files": [
55-
"praw/models/list/moderated.py",
56-
"praw/models/list/__init__.py",
57-
"praw/models/list/base.py",
58-
"praw/models/list/draft.py",
59-
"praw/models/list/redditor.py",
60-
"praw/models/list/trophy.py"
61-
],
62-
"can_expand": true
38+
]
6339
},
6440
{
6541
"name": "Unclassified",
6642
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
67-
"referenced_source_code": [],
68-
"assigned_files": [],
69-
"can_expand": false
43+
"referenced_source_code": []
7044
}
7145
],
7246
"components_relations": [

‎.codeboarding/analysis.json‎

Lines changed: 11 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,10 +13,8 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"praw/__init__.py",
1716
"praw/reddit.py",
18-
"praw/endpoints.py",
19-
"praw/models/auth.py"
17+
"praw/endpoints.py"
2018
],
2119
"can_expand": true
2220
},
@@ -34,7 +32,7 @@
3432
"assigned_files": [
3533
"praw/config.py"
3634
],
37-
"can_expand": true
35+
"can_expand": false
3836
},
3937
{
4038
"name": "Low-Level API Connector",
@@ -94,6 +92,7 @@
9492
"praw/models/inbox.py",
9593
"praw/models/subreddits.py",
9694
"praw/models/stylesheet.py",
95+
"praw/models/auth.py",
9796
"praw/models/reddit/__init__.py",
9897
"praw/models/reddit/submission.py",
9998
"praw/models/reddit/widgets.py",
@@ -176,6 +175,7 @@
176175
"docs/conf.py",
177176
"docs/examples/obtain_refresh_token.py",
178177
"docs/examples/lmgtfy_bot.py",
178+
"praw/__init__.py",
179179
"praw/const.py",
180180
"praw/exceptions.py",
181181
"praw/util/__init__.py",
@@ -268,6 +268,13 @@
268268
"assigned_files": [],
269269
"can_expand": false
270270
},
271+
{
272+
"name": "Unclassified",
273+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
274+
"referenced_source_code": [],
275+
"assigned_files": [],
276+
"can_expand": false
277+
},
271278
{
272279
"name": "Unclassified",
273280
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",

‎.codeboarding/codeboarding_version.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "9a3f8684a62507fb0d190172126efb2f9e773246",
2+
"commit_hash": "59f28329e75d0e8aeec6a0ce8b3a3f0763fbad15",
33
"code_boarding_version": "0.2.0"
44
}

‎.codeboarding/overview.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Overview
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
27+
Unclassified["Unclassified"]
2728
Reddit_Client -- "loads settings from" --> Configuration_Manager
2829
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2930
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -33,7 +34,6 @@ Overview
3334
Listing_Streaming -- "fetches data via" --> Reddit_Client
3435
Listing_Streaming -- "generates" --> Reddit_Data_Models
3536
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
36-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3737
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3838
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3939
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -67,8 +67,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6767
Configuration Manager
6868
^^^^^^^^^^^^^^^^^^^^^
6969

70-
:ref:`Expand <Configuration_Manager>`
71-
7270
Manages loading and accessing PRAW's configuration settings.
7371

7472
**Related Classes/Methods**:
@@ -216,3 +214,10 @@ Unclassified
216214
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
217215

218216
**Related Classes/Methods**: *None*
217+
218+
Unclassified
219+
^^^^^^^^^^^^
220+
221+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
222+
223+
**Related Classes/Methods**: *None*

‎docs/architecture_overview/overview.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ Overview
2424
Unclassified["Unclassified"]
2525
Unclassified["Unclassified"]
2626
Unclassified["Unclassified"]
27+
Unclassified["Unclassified"]
2728
Reddit_Client -- "loads settings from" --> Configuration_Manager
2829
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2930
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -33,7 +34,6 @@ Overview
3334
Listing_Streaming -- "fetches data via" --> Reddit_Client
3435
Listing_Streaming -- "generates" --> Reddit_Data_Models
3536
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
36-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3737
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3838
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3939
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -67,8 +67,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6767
Configuration Manager
6868
^^^^^^^^^^^^^^^^^^^^^
6969

70-
:ref:`Expand <Configuration_Manager>`
71-
7270
Manages loading and accessing PRAW's configuration settings.
7371

7472
**Related Classes/Methods**:
@@ -216,3 +214,10 @@ Unclassified
216214
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
217215

218216
**Related Classes/Methods**: *None*
217+
218+
Unclassified
219+
^^^^^^^^^^^^
220+
221+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
222+
223+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)