Added docu to all public methods - improved english for existing docs - #12
Conversation
PR Compliance Guide 🔍(Compliance updated until commit 41a96f8)Below is a summary of compliance checks for this PR:
Compliance status legend🟢 - Fully Compliant🟡 - Partial Compliant 🔴 - Not Compliant ⚪ - Requires Further Human Verification 🏷️ - Compliance label Previous compliance checksCompliance check up to commit 014020d
Compliance check up to commit 9683bab
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
PR Code Suggestions ✨No code suggestions found for the PR. |
CI Feedback 🧐A test triggered by this PR failed. Here is an AI-generated analysis of the failure:
|
Remove matrix build
PR Type
Documentation
Description
Rewrote documentation for all public methods and types across the codebase
Improved clarity and consistency of docstring formatting and language
Added missing documentation for previously undocumented public APIs
Enhanced parameter descriptions with better examples and context
Diagram Walkthrough
File Walkthrough
14 files
Improved protocol and class documentation clarityComprehensive docs for HTTP methods and interceptorsEnhanced error case documentation and formattingClarified options struct purpose and propertiesAdded convenience bridge method documentationDocumented HTTP method and MIME type enumsAdded docs for logging interceptor and methodsDocumented Linux async/await wrapper functionAdded documentation for logger namespace and instancesDocumented log handler initialization and methodsAdded docs for authorization interceptor classDocumented certificate pinning delegate and methodsImproved public key pinning documentationEnhanced authorization protocol and implementation docs