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

[Diags] Add an edu note explaining StringInterpolationProtocol informal requirements #30827

Merged
merged 1 commit into from
Apr 22, 2020

Conversation

owenv
Copy link
Contributor

@owenv owenv commented Apr 6, 2020

No description provided.

- Not be marked `static`
- Either return `Void` or be marked `@discardableResult`

To learn more about customizing string interpolation behavior, see the standard library documentation of the [`ExpressibleByStringInterpolation`](https://developer.apple.com/documentation/swift/expressiblebystringinterpolation) and [`StringInterpolationProtocol`](https://developer.apple.com/documentation/swift/stringinterpolationprotocol) protocols.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure these links are stable, but this is the only hosted documentation for these protocols I know of

Copy link
Contributor

@beccadax beccadax Apr 8, 2020

Choose a reason for hiding this comment

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

Perhaps some of the SourceKit folks will have some ideas about how to handle URLs like this, or at least ideas about who to ask. Paging @nathawes.

Copy link
Contributor

Choose a reason for hiding this comment

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

Not sure myself, sorry.
@amigi do you know if these are the best links to use / who to ask?

Copy link

Choose a reason for hiding this comment

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

I will check and follow up. Thanks for asking!

@owenv owenv requested a review from beccadax April 6, 2020 15:46
userdocs/diagnostics/string-interpolation-conformance.md Outdated Show resolved Hide resolved
- Not be marked `static`
- Either return `Void` or be marked `@discardableResult`

To learn more about customizing string interpolation behavior, see the standard library documentation of the [`ExpressibleByStringInterpolation`](https://developer.apple.com/documentation/swift/expressiblebystringinterpolation) and [`StringInterpolationProtocol`](https://developer.apple.com/documentation/swift/stringinterpolationprotocol) protocols.
Copy link
Contributor

@beccadax beccadax Apr 8, 2020

Choose a reason for hiding this comment

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

Perhaps some of the SourceKit folks will have some ideas about how to handle URLs like this, or at least ideas about who to ask. Paging @nathawes.

Copy link
Contributor

@beccadax beccadax left a comment

Choose a reason for hiding this comment

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

Some more refinements later on in the note. (Sorry, I should have noticed these issues earlier.)

userdocs/diagnostics/string-interpolation-conformance.md Outdated Show resolved Hide resolved
userdocs/diagnostics/string-interpolation-conformance.md Outdated Show resolved Hide resolved
Copy link
Contributor

@beccadax beccadax left a comment

Choose a reason for hiding this comment

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

LGTM!

@owenv
Copy link
Contributor Author

owenv commented Apr 21, 2020

@swift-ci please smoke test

@owenv
Copy link
Contributor Author

owenv commented Apr 21, 2020

@swift-ci please smoke test macOS

1 similar comment
@owenv
Copy link
Contributor Author

owenv commented Apr 22, 2020

@swift-ci please smoke test macOS

@owenv owenv merged commit 4e0c360 into swiftlang:master Apr 22, 2020
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.

4 participants