Skip to content

Add exec package reference documentation#1266

Draft
j4k4 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-1265
Draft

Add exec package reference documentation#1266
j4k4 with Copilot wants to merge 2 commits into
mainfrom
copilot/fix-1265

Conversation

Copilot AI commented Jul 13, 2025

Copy link
Copy Markdown
Contributor

This PR adds comprehensive reference documentation for the exec package to the gosoline documentation site. The documentation follows the established pattern used by other package reference docs and provides detailed coverage of the package's retry and backoff mechanisms.

What's Added

The new documentation includes:

Core Components

  • Executor interface and implementations (BackoffExecutor, DefaultExecutor)
  • Error classification system with built-in checkers for network/connection errors
  • Context utilities for delayed cancellation and deadline management (WithDelayedCancelContext, WithStoppableDeadlineContext, etc.)
  • Configuration system with predefined backoff types

Documentation Structure

  • Package overview explaining retry logic and resilience patterns
  • Detailed function documentation with usage examples and GitHub links
  • Interface definitions with descriptions
  • Configuration options and settings table
  • Predefined backoff types: "api", "once", "infinite"
  • Three comprehensive usage examples:
    • Basic HTTP client with retries
    • Database operations with custom error handling
    • Configuration-based executor setup

Key Features Documented

  • Exponential backoff with intelligent error classification
  • Built-in error checkers for common network issues (timeouts, connection errors, TLS handshake failures)
  • Resource tracking and logging capabilities
  • Configuration inheritance and fallback mechanisms
  • Context management for graceful operation cancellation

The documentation provides practical examples showing how developers can use the exec package to make their applications more resilient to transient failures in distributed systems.

Screenshot of exec package documentation

Fixes #1265.


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

Co-authored-by: j4k4 <783502+j4k4@users.noreply.github.com>
Copilot AI changed the title [WIP] add exec package reference docs Add exec package reference documentation Jul 13, 2025
Copilot AI requested a review from j4k4 July 13, 2025 18:37
Copilot finished work on behalf of j4k4 July 13, 2025 18:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add exec package reference docs

2 participants