Revamp documentation content and navigation #190
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #190 +/- ##
=======================================
Coverage 89.23% 89.23%
=======================================
Files 14 14
Lines 2007 2007
=======================================
Hits 1791 1791
Misses 216 216 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| - Tutorials: | ||
| - Introductory Tutorial: tutorials/2_introductory_tutorial.ipynb | ||
| - Advanced Tutorial: tutorials/3_advanced_tutorial.ipynb | ||
| - Data Collector Tutorial: tutorials/4_datacollector.ipynb |
There was a problem hiding this comment.
The navigation entries under “Tutorials” point to tutorials/2_introductory_tutorial.ipynb, 3_advanced_tutorial.ipynb, and 4_datacollector.ipynb, but the repository only includes .py tutorials in docs/general/tutorials and the existing notebook versions still live under docs/general/user-guide. MkDocs will error on build because the referenced files do not exist at the declared paths.
Useful? React with 👍 / 👎.
| self.datacollector = DataCollector( | ||
| model=self, | ||
| model_reporters={ | ||
| "total_wealth": lambda m: m.sets["MoneyAgents"].df["wealth"].sum() | ||
| }, | ||
| agent_reporters={"wealth": "wealth"}, | ||
| storage="csv", | ||
| storage_uri="./data", | ||
| trigger=lambda m: m.schedule.steps % 2 == 0, |
There was a problem hiding this comment.
The DataCollector trigger uses lambda m: m.schedule.steps % 2 == 0, but Model only exposes _steps/steps and has no schedule attribute; calling conditional_collect() will raise AttributeError before any data is recorded. The trigger should reference m.steps (or _steps) to match the core Model API.
Useful? React with 👍 / 👎.
|
@coderabbitai review |
✅ Actions performedReview triggered.
|
|
Warning Rate limit exceeded@adamamer20 has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 28 minutes and 20 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (3)
📒 Files selected for processing (18)
Note Other AI code review bot(s) detectedCodeRabbit has detected other AI code review bot(s) in this pull request and will avoid duplicating their findings in the review comments. This may lead to a less comprehensive review. ✨ Finishing touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
Enhance the documentation structure and content for better clarity and usability. This includes updates to navigation, improved API references, and additional examples for key components. The changes aim to provide a more comprehensive and user-friendly experience for developers.