Navigation Menu

Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update discussion of boxed protocol types [SE-0335] #103

Merged
merged 31 commits into from May 26, 2023
Merged

Update discussion of boxed protocol types [SE-0335] #103

merged 31 commits into from May 26, 2023

Conversation

amartini51
Copy link
Collaborator

  • In the Protocols chapter, replace the discussion of existentials with a summary of the ways you can use a protocol as a type, linking forward to the full discussions of generics and existentials and opaque types.
  • Move the discussion of existentials from Protocols to Opaque Types, renaming that chapter to Opaque and Boxed Types.
  • Add a new Boxed Protocol Type section in the reference, to discuss the any keyword.

Pitch thread: https://forums.swift.org/t/61665

Fixes rdar://88208011

@amartini51
Start sketching reference for existential any.
54a8b5a
@amartini51
Mention Any and AnyObject as related to 'any'.
85540f1
@amartini51
Add 'any' to code listings.
bb28dce
@amartini51
Wording & spelling fix.
1f8cee3
@amartini51
Move existentials out of Protocols chapter.
a17a3dd
@amartini51
Add forward references for "protocol as type".
851b86d
@amartini51
Mark some places I need to come back to.
87638d7
@amartini51
Track 'main' to resolve merge conflicts.
5837abb 
Conflicts in:

- Sources/TSPL/TSPL.docc/LanguageGuide/Protocols.md
- Sources/TSPL/TSPL.docc/ReferenceManual/Types.md

Kept the @comment to <!-- --> change from 'main' and the addition of a
new syntactic category from this branch.  Forwarded the changes on
'main' to content that moved into BoxedProtocolTypes.md here.
@amartini51
Move existentials in with opaque types.
4112fde 
This effectively reverts commit a17a3dd and takes a different approach.
@amartini51
Update task marker comments.
9c0990d
@amartini51
Revise outline.
edd9b60 
Incorporates feedback from Xiaodi Wu (@xwu) from the pitch thread.
@amartini51
Rough in a better example of existentials.
462d18a
@amartini51
Fix markup for code voice.
859e88a
@amartini51
Add existentials to the chapter intro.
134ed8d
@amartini51
Expand the code listing and its discussion.
ac1da69 
Avoiding a variadic function arguments keeps the syntax a little
simpler, and using the array of boxed Shape types in a wrapper type
matches the flow of the other examples in the chapter.
@amartini51
Add a rough note about perf impact.
779b444
@amartini51
Use the term "boxed protocol type" consistently.
66fa9cc
@amartini51
Finish contrasting opaque & boxed types in reference.
8f6c37e
@amartini51
Remove old example.
bbb5b19 
Confirmed that the replacement text illustrates the same functionality.
@amartini51
Introduce "box" earlier and clean up phrasing.
ecbe6c5
@amartini51
Track 'main' to resolve merge conflict.
db4ab34 
Changes to TSPL.docc/LanguageGuide/Protocols.md on 'main' deleted stray
whitespace in the Dice exampple, and this branch's changes deleted that
example.
@amartini51
Add an example of as-casting an existential.
f7c0c81
xwu
xwu reviewed Feb 23, 2023
View reviewed changes
TSPL.docc/LanguageGuide/OpaqueTypes.md Outdated Show resolved Hide resolved
TSPL.docc/ReferenceManual/Types.md Outdated Show resolved Hide resolved
@stzn stzn mentioned this pull request Feb 23, 2023
Closed
benrimmington
benrimmington reviewed Feb 23, 2023
View reviewed changes
Copy link
Contributor

@benrimmington benrimmington left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In the "Protocols as Types" section:

TSPL.docc/LanguageGuide/Protocols.md Outdated Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Outdated Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Show resolved Hide resolved
amartini51 and others added 4 commits February 23, 2023 13:47
@amartini51 @xwu @benrimmington
Minor wording adjustments from review.
af9a709 
Co-authored-by: Xiaodi Wu <13952+xwu@users.noreply.github.com>
Co-authored-by: Ben Rimmington <me@benrimmington.com>
@amartini51
Fix a link.
212dbdf 
DocC link syntax follows the destination title, not its filename.  The
chapter part is in UpperCamelCase and the heading is in Upper-Kebab-Case.
@amartini51
Use proper markup for new grammar production.
203b915
@amartini51
Fix em-dash.
f808c8f
chuckdude
chuckdude approved these changes May 1, 2023
View reviewed changes
Copy link
Contributor

@chuckdude chuckdude left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very minor edits; approving with changes.

TSPL.docc/LanguageGuide/OpaqueTypes.md Show resolved Hide resolved
TSPL.docc/LanguageGuide/OpaqueTypes.md Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Outdated Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Outdated Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Outdated Show resolved Hide resolved
TSPL.docc/LanguageGuide/Protocols.md Show resolved Hide resolved
@amartini51
Incorporate edits.
4754b42 
Co-authored-by: Chuck Toporek <chuck_toporek@apple.com>
@amartini51 amartini51 merged commit 01c93c9 into apple:main May 26, 2023
@amartini51 amartini51 deleted the existential_any_88208011 branch May 26, 2023 22:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@xwu xwu xwu left review comments

@chuckdude chuckdude chuckdude approved these changes

@benrimmington benrimmington benrimmington left review comments

@bjlanier bjlanier bjlanier approved these changes

@hborla hborla Awaiting requested review from hborla

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
6 participants
@amartini51 @xwu @chuckdude @benrimmington @hborla @bjlanier