-
Notifications
You must be signed in to change notification settings - Fork 187
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
[cxx-interop] add initial 'Mixing Swift and C++' docu… #299
Conversation
initial discussion on the forums is here: https://forums.swift.org/t/documenting-support-for-c-interoperability/64828/1 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is awesome, thanks Alex!
2f7b3e1
to
80127e8
Compare
80127e8
to
38f626f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This will be a great addition to the Swift.org documentation! I left some smaller comments regarding the structure.
Also, we may want to mark this PR as a draft until it's ready to be merged.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great! Left two comments, at least one of which we can address later.
I will ping the rest of the SWWG as well to see if they have any feedback to give, but as everyone's quite busy these days I think it's best to just merge this when you're ready for it and then improve things if necessary in a later PR.
Edit: As I still haven't had time to look into #305, we sadly won't have time to fix the highlighting before shipping this. I will try to get it done soon though.
--- | ||
layout: page | ||
title: Mix Swift and C++ | ||
official_url: https://swift.org/documentation/cxx-interop/ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These official_url
s should not be necessary. I'm not sure why it's used in the API Guidelines. It's something we (the SWWG) can revisit at another point though.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Okay, I'll keep it here for now then.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've had a quick scan through and looks sensible to me other than @alexandersandberg 's comments
I had a few small comments. Overall though this is a significant addition, thank you to everyone who wrote and contributed to this! One additional question I did have. Will readers understand that the phrase “A development version of Swift” means an unreleased version of Swift? Some people may read that as “A version of Swift I can use for development” and then be confused that it doesn’t work in the current release. That phrase is used in a number of places throughout the PR. If this support is in the development branch of Swift 5.9, maybe we should be explicit about what version it is in? The release process for Swift 5.9 was announced back in March, so it is public info. |
|
Marked as draft for now while addressing the remaining comments today |
…with mutable fields
@swift-ci please test |
@swift-ci test |
…mentation guide
Draft page preview
Github markdown rendered index page:
https://github.com/hyp/swift-org-website/blob/interop-doc-hello-world/documentation/cxx-interop/index.md
Motivation:
This is an initial skeleton page for the planned documentation guide for how the Swift and C++ interoperability Swift language feature.
We are planning to use initial skeleton page PR to discuss documentation more in depth with the C++ interoperability workgroup, and also present our proposal for documenting Swift and C++ interoperability to the the website workgroup as well.
This PR will be updated until we get to the point where we have some initial documentation for this feature that can be put out on the website.
Modifications:
Added documentation/cxx-interop page.
Result:
Swift will have an initial guide for how to use Swift and C++ interoperability.