docs: fix README TOC order to match section order - #316
Conversation
The TOC listed Retries before Calling Other Endpoints, but the sections in the body appear in the opposite order (and all sibling SDKs list Calling Other Endpoints first). Reorder the two TOC entries and normalize spacing before the Calling Other Endpoints heading. No content removed.
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review. WalkthroughThe README table of contents now places “Calling Other Endpoints” before “Retries”. A blank line separates the Write Assertions example from the next section. ChangesREADME structure
Estimated code review effort: 1 (Trivial) | ~2 minutes Merge Risk: ⚪ Minimal · up to This localized documentation change only aligns the README table of contents with the existing section order and normalizes spacing; no actionable merge-blocking risk remains. Suggested reviewers: 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
Codecov Report✅ All modified and coverable lines are covered by tests. ❌ Your project status has failed because the head coverage (69.93%) is below the target coverage (80.00%). You can increase the head coverage or adjust the target coverage. Additional details and impacted files@@ Coverage Diff @@
## main #316 +/- ##
=======================================
Coverage 69.93% 69.93%
=======================================
Files 142 142
Lines 10774 10774
=======================================
Hits 7535 7535
Misses 3239 3239 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Pull request overview
Updates the Python SDK README to keep the table of contents aligned with the actual section order (and consistent with sibling SDKs), without changing documentation content.
Changes:
- Reordered the README TOC entries so Calling Other Endpoints appears before Retries.
- Normalized whitespace before the Calling Other Endpoints heading to match surrounding formatting.
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
The TOC listed Retries before Calling Other Endpoints, but the sections in the body appear in the opposite order (and all sibling SDKs list Calling Other Endpoints first). Reorder the two TOC entries and normalize spacing before the Calling Other Endpoints heading. No content removed.
This is to be able to synch the generator with the sdks using the templates and have a consistent ordering across SDKs.
Description
What problem is being solved?
How is it being solved?
What changes are made to solve it?
References
Review Checklist
mainSummary by CodeRabbit