apple / apple/swift-http-structured-headers

Let primary APIs have the better module name (CodableStructuredHeaders -> StructuredHeaders)

Open
#9 0 comments 4 reactions 0 assignees View on GitHub
Dominant language
Swift
Stars
195
Forks
36
PR merge metrics
No merged PRs in 30d

Description

As mentioned in the [announcement thread](https://forums.swift.org/t/introducing-swift-http-structured-headers/44041/5), if users are intended to start with the higher level module, `CodableStructuredHeaders`, shouldn't it get the better module name? This increases discoverability (users don't need to know about the other module) and allows users to start at the high level rather than low. The current `StructuredHeaders` could be renamed to `LowLevelStructuredHeaders` or anything else that indicates it's lower level than the other module.

Contributor guide

No contributing guide indexed for this repository

Research direction

Start by inspecting the package and module declarations, then trace references to StructuredHeaders and CodableStructuredHeaders across the repository. Determine the final public and lower-level names with maintainers; done means the rename is applied consistently and the package still builds and tests pass.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
api, developer-experience
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.