docs(spp_farmer_registry_demo,spp_mis_demo_v2): sync descriptions with code#131
docs(spp_farmer_registry_demo,spp_mis_demo_v2): sync descriptions with code#131
Conversation
…h code - Create DESCRIPTION.md for spp_farmer_registry_demo (was missing) - Fix spp_mis_demo_v2: 6 programs -> 7, document seeded generation, add Conditional Child Grant, multi-locale, geographic data loading
Summary of ChangesHello, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on synchronizing and enhancing the documentation for two demo data generators, Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for GitHub and other Google products, sign up here. Footnotes
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation for spp_farmer_registry_demo and spp_mis_demo_v2. A new DESCRIPTION.md is added for the farmer registry demo, and the existing one for the MIS demo is updated to reflect new features like additional programs and seeded data generation. The changes are accurate and improve the documentation. I have a couple of suggestions to further improve the documentation's consistency and formatting.
| | Model | Description | | ||
| | ------------------------------ | --------------------------------------------------- | | ||
| | `spp.farmer.demo.generator` | Core demo generator wizard with all generation logic | |
There was a problem hiding this comment.
The markdown table formatting is a bit messy. For better readability and maintainability of the source, please align the columns.
| | Model | Description | | |
| | ------------------------------ | --------------------------------------------------- | | |
| | `spp.farmer.demo.generator` | Core demo generator wizard with all generation logic | | |
| | Model | Description | | |
| |-------------------------------|------------------------------------------------------| | |
| | `spp.farmer.demo.generator` | Core demo generator wizard with all generation logic | |
| All programs use CEL expressions with activated registry variables: | ||
|
|
||
| - **Universal Child Grant**: `r.is_group == true and child_count > 0` (member aggregation) | ||
| - **Conditional Child Grant**: First 1,000 days targeting for young children |
There was a problem hiding this comment.
The newly added 'Conditional Child Grant' program is missing its CEL eligibility expression, unlike the other programs in this list. For consistency and completeness, please add the CEL expression.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## 19.0 #131 +/- ##
========================================
Coverage 69.96% 69.97%
========================================
Files 832 835 +3
Lines 48813 49061 +248
========================================
+ Hits 34154 34331 +177
- Misses 14659 14730 +71
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
Include auto-generated README.rst and index.html from oca-gen-addon-readme (Python 3.11) to match CI expectations.
- spp_case_demo: mention 3 background cases, clarify non-deterministic generation - spp_grm_demo: list all 8 personas, add missing dependencies (spp_grm_registry, spp_grm_programs), clarify non-deterministic generation
Include auto-generated README.rst and index.html from oca-gen-addon-readme (Python 3.11) to match CI expectations.
Delete README.md — its content is covered by readme/DESCRIPTION.md (module description) and docs/USE_CASES.md (developer guide). Fix "6 programs" -> "7 programs" in USE_CASES.md overview.
1 participant
Why is this change needed?
spp_farmer_registry_demohad noreadme/DESCRIPTION.mdat allspp_mis_demo_v2DESCRIPTION.md was out of sync with the actual code (wrong program count, missing seeded generation details)How was the change implemented?
New unit tests
N/A (documentation only)
Unit tests executed by the author
N/A
How to test manually
Review the DESCRIPTION.md files for accuracy against the code.
Related links