Add comprehensive documentation to achieve 100% coverage.#7
Merged
samuel-williams-shopify merged 1 commit intomainfrom Aug 26, 2025
Merged
Conversation
- Added detailed documentation for all 8 interface methods with proper @parameter, @returns, and @yields pragmas - Documented Interface module with clear description - Added @namespace pragmas to organizational modules in version.rb - Achieved 12/12 definitions documented (100% coverage) - All documentation follows project standards from decode gem guidelines Methods documented: - trace: Creates trace spans with name and attributes - trace_context=: Sets current trace context - active?: Checks for active trace span - trace_context: Gets current trace context - current_context: Gets OpenTelemetry context - with_context: Executes code within context - inject: Injects trace context into headers - extract: Extracts trace context from headers
samuel-williams-shopify
deleted the
feature/add-comprehensive-documentation
branch
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Methods documented:
Types of Changes
Contribution