Skip to content

docs: clarify request depth semantics#878

Open
StantonMatt wants to merge 1 commit into
gocolly:masterfrom
StantonMatt:stanton/docs-request-depth
Open

docs: clarify request depth semantics#878
StantonMatt wants to merge 1 commit into
gocolly:masterfrom
StantonMatt:stanton/docs-request-depth

Conversation

@StantonMatt

Copy link
Copy Markdown

Summary

  • Document Request.Depth and MaxDepth as 1-based values.
  • Update the max-depth examples so their comments match root depth 1 and child depth 2.
  • Add a regression test for root and child request depth values.

Fixes #769

Verification

  • go test . -run TestCollectorRequestDepthValues -count=1 -v
  • go test ./... -count=1
  • go test ./_examples/max_depth ./_examples/parallel
  • git diff --check

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.

Misleading Request.Depth documentation

1 participant