swift-server / swift-server/async-http-client

delegate docs need clarification about didReceiveError/didFinishRequest

Open
#390 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Swift
Stars
1.1k
Forks
156
No merged PRs in 30d

Description

Immediate questions:

  • will didFinishRequest be called after didReceiveError? Yes/No/Maybe
  • can didSendRequestHead be called if either didFinishRequest / didReceiveError were previously called?
  • can didReceiveBodyPart be called if either didFinishRequest / didReceiveError were previously called?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the delegate documentation and the implementations or tests covering didReceiveError, didFinishRequest, didSendRequestHead, and didReceiveBodyPart. Determine the callback ordering and document the answers to the three questions, with the documentation matching the established behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.