update masque-go documentation to the v0.4.0 release - #133
Merged
Conversation
📝 WalkthroughWalkthroughDocumentation for the CONNECT-UDP client and proxy examples was revised to reflect updated masque API usage: client docs now show masque.Transport/masque.NewRequest-based dialing and ClientConn multiplexing, while proxy docs switch examples to masque.ParseProxyRequest, masque.ProxyRequestParseError, and ProxyRequest.Target. ChangesCONNECT-UDP documentation updates
Estimated code review effort: 2 (Simple) | ~10 minutes Related PRs: None specified. Suggested labels: documentation Suggested reviewers: None specified. 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
✨ Simplify code
Comment |
Member
Author
|
@coderabbitai configuration |
|
Configuration used: Organization UI CodeRabbit configuration# Source: Organization UI (base)
language: en-US
# Source: Organization UI (base)
tone_instructions: ''
# Source: Organization UI (base)
early_access: false
# Source: Organization UI (base)
enable_free_tier: true
# Source: Organization UI (base)
inheritance: false
reviews:
# Source: Organization UI (base)
profile: chill
# Source: Organization UI (base)
request_changes_workflow: false
# Source: Organization UI (base)
high_level_summary: true
# Source: Organization UI (base)
high_level_summary_instructions: ''
# Source: Organization UI (base)
high_level_summary_placeholder: '`@coderabbitai` summary'
# Source: Organization UI (base)
high_level_summary_in_walkthrough: false
# Source: Organization UI (base)
auto_title_placeholder: '`@coderabbitai`'
# Source: Organization UI (base)
auto_title_instructions: ''
# Source: Organization UI (base)
review_status: true
# Source: Organization UI (base)
review_details: false
# Source: Organization UI (base)
commit_status: true
# Source: Organization UI (base)
fail_commit_status: false
# Source: Organization UI (base)
collapse_walkthrough: true
# Source: Organization UI (base)
changed_files_summary: true
# Source: Organization UI (base)
sequence_diagrams: true
# Source: Organization UI (base)
estimate_code_review_effort: true
# Source: Organization UI (base)
assess_linked_issues: true
# Source: Organization UI (base)
related_issues: true
# Source: Organization UI (base)
related_prs: true
# Source: Organization UI (base)
suggested_labels: true
# Source: defaults
labeling_instructions: []
# Source: defaults
mutually_exclusive_groups: {}
# Source: Organization UI (base)
auto_apply_labels: false
# Source: Organization UI (base)
suggested_reviewers: true
# Source: Organization UI (base)
auto_assign_reviewers: false
# Source: defaults
suggested_reviewers_instructions: []
# Source: Organization UI (base)
in_progress_fortune: true
# Source: Organization UI (base)
poem: false
# Source: Organization UI (base)
enable_prompt_for_ai_agents: true
# Source: defaults
path_filters: []
# Source: defaults
path_instructions: []
# Source: Organization UI (base)
abort_on_close: true
# Source: Organization UI (base)
disable_cache: false
slop_detection:
# Source: Organization UI (base)
enabled: true
auto_review:
# Source: Organization UI (base)
enabled: true
# Source: Organization UI (base)
description_keyword: ''
# Source: Organization UI (base)
auto_incremental_review: true
# Source: Organization UI (base)
auto_pause_after_reviewed_commits: 5
# Source: defaults
ignore_title_keywords: []
# Source: defaults
labels: []
# Source: Organization UI (base)
drafts: false
# Source: Organization UI (base)
base_branches:
- .*
# Source: defaults
ignore_usernames: []
finishing_touches:
docstrings:
# Source: Organization UI (base)
enabled: true
unit_tests:
# Source: Organization UI (base)
enabled: true
simplify:
# Source: Organization UI (base)
enabled: true
autofix:
# Source: Organization UI (base)
enabled: true
# Source: defaults
custom: []
pre_merge_checks:
# Source: Organization UI (base)
override_requested_reviewers_only: false
docstrings:
# Source: Organization UI (base)
mode: warning
# Source: Organization UI (base)
threshold: 80
title:
# Source: Organization UI (base)
mode: warning
# Source: Organization UI (base)
requirements: ''
description:
# Source: Organization UI (base)
mode: warning
issue_assessment:
# Source: Organization UI (base)
mode: warning
# Source: defaults
custom_checks: []
tools:
ast-grep:
# Source: defaults
rule_dirs: []
# Source: defaults
util_dirs: []
# Source: Organization UI (base)
essential_rules: true
# Source: defaults
packages: []
shellcheck:
# Source: Organization UI (base)
enabled: true
ruff:
# Source: Organization UI (base)
enabled: true
markdownlint:
# Source: Organization UI (base)
enabled: true
github-checks:
# Source: Organization UI (base)
enabled: true
# Source: Organization UI (base)
timeout_ms: 90000
languagetool:
# Source: Organization UI (base)
enabled: true
# Source: defaults
enabled_rules: []
# Source: defaults
disabled_rules: []
# Source: defaults
enabled_categories: []
# Source: defaults
disabled_categories: []
# Source: Organization UI (base)
enabled_only: false
# Source: Organization UI (base)
level: default
biome:
# Source: Organization UI (base)
enabled: true
hadolint:
# Source: Organization UI (base)
enabled: true
swiftlint:
# Source: Organization UI (base)
enabled: true
phpstan:
# Source: Organization UI (base)
enabled: true
# Source: Organization UI (base)
level: default
phpmd:
# Source: Organization UI (base)
enabled: true
phpcs:
# Source: Organization UI (base)
enabled: true
golangci-lint:
# Source: Organization UI (base)
enabled: true
yamllint:
# Source: Organization UI (base)
enabled: true
gitleaks:
# Source: Organization UI (base)
enabled: true
trufflehog:
# Source: Organization UI (base)
enabled: true
checkov:
# Source: Organization UI (base)
enabled: true
tflint:
# Source: Organization UI (base)
enabled: true
detekt:
# Source: Organization UI (base)
enabled: true
eslint:
# Source: Organization UI (base)
enabled: true
flake8:
# Source: Organization UI (base)
enabled: true
fbinfer:
# Source: Organization UI (base)
enabled: true
# Source: Organization UI (base)
enable_java: false
fortitudeLint:
# Source: Organization UI (base)
enabled: true
rubocop:
# Source: Organization UI (base)
enabled: true
buf:
# Source: Organization UI (base)
enabled: true
regal:
# Source: Organization UI (base)
enabled: true
actionlint:
# Source: Organization UI (base)
enabled: true
zizmor:
# Source: Organization UI (base)
enabled: true
pmd:
# Source: Organization UI (base)
enabled: true
clang:
# Source: Organization UI (base)
enabled: true
cppcheck:
# Source: Organization UI (base)
enabled: true
opengrep:
# Source: Organization UI (base)
enabled: true
semgrep:
# Source: Organization UI (base)
enabled: true
circleci:
# Source: Organization UI (base)
enabled: true
clippy:
# Source: Organization UI (base)
enabled: true
sqlfluff:
# Source: Organization UI (base)
enabled: true
trivy:
# Source: Organization UI (base)
enabled: true
prismaLint:
# Source: Organization UI (base)
enabled: true
pylint:
# Source: Organization UI (base)
enabled: true
oxc:
# Source: Organization UI (base)
enabled: true
shopifyThemeCheck:
# Source: Organization UI (base)
enabled: true
luacheck:
# Source: Organization UI (base)
enabled: true
brakeman:
# Source: Organization UI (base)
enabled: true
dotenvLint:
# Source: Organization UI (base)
enabled: true
htmlhint:
# Source: Organization UI (base)
enabled: true
stylelint:
# Source: Organization UI (base)
enabled: true
checkmake:
# Source: Organization UI (base)
enabled: true
osvScanner:
# Source: Organization UI (base)
enabled: true
oasdiff:
# Source: Organization UI (base)
enabled: true
reactDoctor:
# Source: Organization UI (base)
enabled: true
presidio:
# Source: Organization UI (base)
enabled: true
blinter:
# Source: Organization UI (base)
enabled: true
smartyLint:
# Source: Organization UI (base)
enabled: true
emberTemplateLint:
# Source: Organization UI (base)
enabled: true
skillspector:
# Source: Organization UI (base)
enabled: true
psscriptanalyzer:
# Source: Organization UI (base)
enabled: true
chat:
# Source: Organization UI (base)
art: false
# Source: Organization UI (base)
allow_non_org_members: true
# Source: Organization UI (base)
auto_reply: true
integrations:
jira:
# Source: Organization UI (base)
usage: auto
linear:
# Source: Organization UI (base)
usage: auto
knowledge_base:
# Source: Organization UI (base)
opt_out: false
web_search:
# Source: Organization UI (base)
enabled: true
code_guidelines:
# Source: Organization UI (base)
enabled: true
# Source: defaults
filePatterns: []
learnings:
# Source: Organization UI (base)
scope: auto
# Source: Organization UI (base)
approval_delay: 0
issues:
# Source: Organization UI (base)
scope: auto
jira:
# Source: Organization UI (base)
usage: auto
# Source: defaults
project_keys: []
linear:
# Source: Organization UI (base)
usage: auto
# Source: defaults
team_keys: []
pull_requests:
# Source: Organization UI (base)
scope: auto
mcp:
# Source: Organization UI (base)
usage: auto
# Source: defaults
disabled_servers: []
# Source: Organization UI (base)
automatic_repository_linking: false
# Source: defaults
linked_repositories: []
code_generation:
docstrings:
# Source: Organization UI (base)
language: en-US
# Source: defaults
path_instructions: []
unit_tests:
# Source: defaults
path_instructions: []
issue_enrichment:
auto_enrich:
# Source: Organization UI (base)
enabled: false
planning:
# Source: Organization UI (base)
enabled: true
auto_planning:
# Source: Organization UI (base)
enabled: true
# Source: defaults
labels: []
labeling:
# Source: defaults
labeling_instructions: []
# Source: Organization UI (base)
auto_apply_labels: false
|
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
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.
Update masque-go documentation to the v0.4.0 API
masque.Client.DialAddr/DialAPI withmasque.NewRequestandmasque.Transport.Dial, including examples for setting request headers and reusing QUIC connections viaTransport.NewClientConn.masque.ParseRequest→masque.ParseProxyRequestandmasque.RequestParseError→masque.ProxyRequestParseError, and documents thatproxy.Proxynow sends aProxy-Statusresponse header automatically.📊 Macroscope summarized dc47702. 2 files reviewed, 0 issues evaluated, 0 issues filtered, 0 comments posted
🗂️ Filtered Issues
No issues evaluated.
Summary by CodeRabbit