[PR #43] [MERGED] docs: Simplify examples by removing excessive status checks #43

New issue

Closed

opened 2026-02-26 17:32:17 +03:00 by kerem · 0 comments

kerem commented

2026-02-26 17:32:17 +03:00

Owner

📋 Pull Request Information

Original PR: https://github.com/Corsinvest/cv4pve-api-php/pull/43
Author: @franklupo
Created: 12/12/2025
Status: ✅ Merged
Merged: 12/12/2025
Merged by: @franklupo

Base: master ← Head: simplify-examples

📝 Commits (1)

0082232 docs: Simplify examples by removing excessive status checks

📊 Changes

5 files changed (+192 additions, -312 deletions)

View changed files

📝 docs/advanced.md (+8 -16)
📝 docs/api.md (+70 -109)
📝 docs/common-issues.md (+47 -82)
📝 docs/examples.md (+49 -69)
📝 docs/results.md (+18 -36)

📄 Description

Summary

Streamlined documentation examples to improve readability by removing redundant isSuccessStatusCode() checks from basic usage examples.

Changes

examples.md: 13→1 checks (-92%)
api.md: 17→4 checks (removed production check comments)
common-issues.md: 15→2 checks (-87%)
results.md: 9→5 checks (kept best practices section)
advanced.md: 7→9 checks (enterprise patterns kept intact)

What was retained

Status checks were intentionally retained in:

Error handling sections and best practices
Resilient operations and monitoring functions
Functions that throw exceptions
errorhandling.md (dedicated to error handling patterns)

Impact

192 lines added, 312 lines removed (120 lines net reduction)
Examples are now more concise and easier to understand for newcomers
Aligns with modern PHP documentation practices
Proper error handling patterns preserved where pedagogically important

Files excluded

README.md - kept as is (as requested)
errorhandling.md - dedicated to error handling, all checks appropriate

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/Corsinvest/cv4pve-api-php/pull/43 **Author:** [@franklupo](https://github.com/franklupo) **Created:** 12/12/2025 **Status:** ✅ Merged **Merged:** 12/12/2025 **Merged by:** [@franklupo](https://github.com/franklupo) **Base:** `master` ← **Head:** `simplify-examples` --- ### 📝 Commits (1) - [`0082232`](https://github.com/Corsinvest/cv4pve-api-php/commit/00822326557ad1756edf2d6d5674df9c7154e9e0) docs: Simplify examples by removing excessive status checks ### 📊 Changes **5 files changed** (+192 additions, -312 deletions) <details> <summary>View changed files</summary> 📝 `docs/advanced.md` (+8 -16) 📝 `docs/api.md` (+70 -109) 📝 `docs/common-issues.md` (+47 -82) 📝 `docs/examples.md` (+49 -69) 📝 `docs/results.md` (+18 -36) </details> ### 📄 Description ## Summary Streamlined documentation examples to improve readability by removing redundant `isSuccessStatusCode()` checks from basic usage examples. ## Changes - **examples.md**: 13→1 checks (-92%) - **api.md**: 17→4 checks (removed production check comments) - **common-issues.md**: 15→2 checks (-87%) - **results.md**: 9→5 checks (kept best practices section) - **advanced.md**: 7→9 checks (enterprise patterns kept intact) ## What was retained Status checks were intentionally retained in: - Error handling sections and best practices - Resilient operations and monitoring functions - Functions that throw exceptions - `errorhandling.md` (dedicated to error handling patterns) ## Impact - 192 lines added, 312 lines removed (120 lines net reduction) - Examples are now more concise and easier to understand for newcomers - Aligns with modern PHP documentation practices - Proper error handling patterns preserved where pedagogically important ## Files excluded - `README.md` - kept as is (as requested) - `errorhandling.md` - dedicated to error handling, all checks appropriate --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>