Skip to content

Commit a0d46f0

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 c595221 commit a0d46f0

6 files changed

Lines changed: 30 additions & 106 deletions

File tree

‎.codeboarding/Configuration_Manager.json‎

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

‎.codeboarding/Configuration_Manager.rst‎

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

‎.codeboarding/analysis.json‎

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@
1313
}
1414
],
1515
"assigned_files": [
16-
"praw/reddit.py",
17-
"praw/endpoints.py"
16+
"praw/reddit.py"
1817
],
1918
"can_expand": true
2019
},
@@ -32,7 +31,7 @@
3231
"assigned_files": [
3332
"praw/config.py"
3433
],
35-
"can_expand": true
34+
"can_expand": false
3635
},
3736
{
3837
"name": "Low-Level API Connector",
@@ -79,7 +78,6 @@
7978
"praw/models/__init__.py",
8079
"praw/models/mod_note.py",
8180
"praw/models/base.py",
82-
"praw/models/util.py",
8381
"praw/models/front.py",
8482
"praw/models/preferences.py",
8583
"praw/models/redditors.py",
@@ -88,7 +86,6 @@
8886
"praw/models/comment_forest.py",
8987
"praw/models/mod_notes.py",
9088
"praw/models/trophy.py",
91-
"praw/models/helpers.py",
9289
"praw/models/inbox.py",
9390
"praw/models/subreddits.py",
9491
"praw/models/stylesheet.py",
@@ -177,10 +174,13 @@
177174
"docs/examples/lmgtfy_bot.py",
178175
"praw/__init__.py",
179176
"praw/const.py",
177+
"praw/endpoints.py",
180178
"praw/exceptions.py",
181179
"praw/util/__init__.py",
182180
"praw/util/cache.py",
183-
"praw/util/snake.py"
181+
"praw/util/snake.py",
182+
"praw/models/util.py",
183+
"praw/models/helpers.py"
184184
],
185185
"can_expand": false
186186
},
@@ -219,6 +219,13 @@
219219
"assigned_files": [],
220220
"can_expand": false
221221
},
222+
{
223+
"name": "Unclassified",
224+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
225+
"referenced_source_code": [],
226+
"assigned_files": [],
227+
"can_expand": false
228+
},
222229
{
223230
"name": "Unclassified",
224231
"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": "ea80ca676fe8ba004e01e2c2cd3b178110006f2f",
2+
"commit_hash": "c595221bd4e1eee10beca3646b04b0133dbf02ca",
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
@@ -17,6 +17,7 @@ Overview
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Reddit_Client -- "loads settings from" --> Configuration_Manager
2122
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2223
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -26,7 +27,6 @@ Overview
2627
Listing_Streaming -- "fetches data via" --> Reddit_Client
2728
Listing_Streaming -- "generates" --> Reddit_Data_Models
2829
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
29-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3030
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3131
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3232
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -60,8 +60,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6060
Configuration Manager
6161
^^^^^^^^^^^^^^^^^^^^^
6262

63-
:ref:`Expand <Configuration_Manager>`
64-
6563
Manages loading and accessing PRAW's configuration settings.
6664

6765
**Related Classes/Methods**:
@@ -160,3 +158,10 @@ Unclassified
160158
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161159

162160
**Related Classes/Methods**: *None*
161+
162+
Unclassified
163+
^^^^^^^^^^^^
164+
165+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
166+
167+
**Related Classes/Methods**: *None*

‎docs/architecture_overview/overview.rst‎

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,7 @@ Overview
1717
Unclassified["Unclassified"]
1818
Unclassified["Unclassified"]
1919
Unclassified["Unclassified"]
20+
Unclassified["Unclassified"]
2021
Reddit_Client -- "loads settings from" --> Configuration_Manager
2122
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2223
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -26,7 +27,6 @@ Overview
2627
Listing_Streaming -- "fetches data via" --> Reddit_Client
2728
Listing_Streaming -- "generates" --> Reddit_Data_Models
2829
click Reddit_Client href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Client.html" "Details"
29-
click Configuration_Manager href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Configuration_Manager.html" "Details"
3030
click Low_Level_API_Connector href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Low_Level_API_Connector.html" "Details"
3131
click Object_Transformer href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Object_Transformer.html" "Details"
3232
click Reddit_Data_Models href "https://github.com/CodeBoarding/praw/blob/main/.codeboarding/Reddit_Data_Models.html" "Details"
@@ -60,8 +60,6 @@ The primary interface for interacting with the Reddit API, managing authenticati
6060
Configuration Manager
6161
^^^^^^^^^^^^^^^^^^^^^
6262

63-
:ref:`Expand <Configuration_Manager>`
64-
6563
Manages loading and accessing PRAW's configuration settings.
6664

6765
**Related Classes/Methods**:
@@ -160,3 +158,10 @@ Unclassified
160158
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
161159

162160
**Related Classes/Methods**: *None*
161+
162+
Unclassified
163+
^^^^^^^^^^^^
164+
165+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
166+
167+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)