Skip to content

Commit ea80ca6

Browse files
committed
docs: update codeboarding documentation
## 📚 Documentation Update This commit contains updated documentation files fetched from the CodeBoarding service. ### 📊 Summary - Documentation files created/updated: 7 - JSON files created/updated: 8 - 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 38807c4 commit ea80ca6

5 files changed

Lines changed: 29 additions & 14 deletions

File tree

.codeboarding/Configuration_Manager.json

Lines changed: 3 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,7 @@
1111
"reference_start_line": 52,
1212
"reference_end_line": 52
1313
}
14-
],
15-
"assigned_files": [
16-
"praw/config.py"
17-
],
18-
"can_expand": true
14+
]
1915
},
2016
{
2117
"name": "Reddit API Client",
@@ -27,16 +23,12 @@
2723
"reference_start_line": 57,
2824
"reference_end_line": 901
2925
}
30-
],
31-
"assigned_files": [],
32-
"can_expand": true
26+
]
3327
},
3428
{
3529
"name": "Unclassified",
3630
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
37-
"referenced_source_code": [],
38-
"assigned_files": [],
39-
"can_expand": false
31+
"referenced_source_code": []
4032
}
4133
],
4234
"components_relations": [

.codeboarding/analysis.json

Lines changed: 9 additions & 2 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
},
@@ -177,6 +176,7 @@
177176
"docs/examples/lmgtfy_bot.py",
178177
"praw/__init__.py",
179178
"praw/const.py",
179+
"praw/endpoints.py",
180180
"praw/exceptions.py",
181181
"praw/util/__init__.py",
182182
"praw/util/cache.py",
@@ -205,6 +205,13 @@
205205
"assigned_files": [],
206206
"can_expand": false
207207
},
208+
{
209+
"name": "Unclassified",
210+
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
211+
"referenced_source_code": [],
212+
"assigned_files": [],
213+
"can_expand": false
214+
},
208215
{
209216
"name": "Unclassified",
210217
"description": "Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)",
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
{
2-
"commit_hash": "dfc529df9bae4992a2e446efc1c98f6fddf006be",
2+
"commit_hash": "38807c47c93eb29b7c540e44196a7adf38433464",
33
"code_boarding_version": "0.2.0"
44
}

.codeboarding/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Overview
1515
Unclassified["Unclassified"]
1616
Unclassified["Unclassified"]
1717
Unclassified["Unclassified"]
18+
Unclassified["Unclassified"]
1819
Reddit_Client -- "loads settings from" --> Configuration_Manager
1920
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2021
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -144,3 +145,10 @@ Unclassified
144145
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
145146

146147
**Related Classes/Methods**: *None*
148+
149+
Unclassified
150+
^^^^^^^^^^^^
151+
152+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
153+
154+
**Related Classes/Methods**: *None*

docs/architecture_overview/overview.rst

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Overview
1515
Unclassified["Unclassified"]
1616
Unclassified["Unclassified"]
1717
Unclassified["Unclassified"]
18+
Unclassified["Unclassified"]
1819
Reddit_Client -- "loads settings from" --> Configuration_Manager
1920
Reddit_Client -- "delegates requests to" --> Low_Level_API_Connector
2021
Low_Level_API_Connector -- "returns raw response to" --> Reddit_Client
@@ -144,3 +145,10 @@ Unclassified
144145
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
145146

146147
**Related Classes/Methods**: *None*
148+
149+
Unclassified
150+
^^^^^^^^^^^^
151+
152+
Component for all unclassified files and utility functions (Utility functions/External Libraries/Dependencies)
153+
154+
**Related Classes/Methods**: *None*

0 commit comments

Comments
 (0)