search

swiftlang / swift-book

The Swift Programming Language book
Apache License 2.0
1.75k stars 161 forks source link

Add missing "Protocol" to the title #297

Closed stzn closed 6 months ago

stzn commented 6 months ago

In the content, "boxed protocol types" is used, but it's not used in the title. I'm not sure if it's intended or not, but it looks missing "Protocol".

amartini51 commented 6 months ago

Thanks for this PR!

I also discussed this change with @chuckdude and @bjlanier. I wasn't sure if naming the chapter "Opaque and Boxed Protocol Types" might be misread as "opaque and boxed" modifying "protocol types". Spelling it out fully as "Opaque Types and Boxed Protocol Types" is a little too long. They agreed that this change makes sense, and isn't too easy to misread.

They also noted that we want to make sure the URL doesn't change. I'm pretty sure the URL comes from the filename, not the title — for example, A Swift Tour is at https://docs.swift.org/swift-book/documentation/the-swift-programming-language/guidedtour — but I will confirm when building.

amartini51 commented 6 months ago

Confirmed the URL path remains /opaquetypes for the chapter we're changing. Spot-checked the diff in the build product between this PR and 'main' — no unexpected changes to the JSON. Looks good!