Improve the in-source docs of the PackageDescription API for better readability. #2175
+460
−352
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
aciidgh
reviewed
Jun 19, 2019
Contributor
aciidgh
left a comment
aciidgh
left a comment
There was a problem hiding this comment.
Very minor comments but otherwise this looks great! Thanks for all the work on this :)
| /// is recommended to not declare the type of library explicitly to let the | ||
| /// Swift Package Manager choose between static or dynamic linking depending | ||
| /// on the consumer of the package. | ||
| /// A library’s product can either be statically or dynamically linked. |
Contributor
There was a problem hiding this comment.
the quote seems weird, shouldn't it be '?
Contributor
Author
There was a problem hiding this comment.
We often use curly quotes, I can change all of them to straight quotes if you prefer that?
Contributor
There was a problem hiding this comment.
I am fine with whichever one is preferred but we should make it consistent throughout the docs.
Contributor
Author
There was a problem hiding this comment.
I decided to use the regular quotes for consistency with other docs.
aciidgh
force-pushed
the
Enhancement/Update-Source-Docs
branch
from
a9d31ac to
f6292e6
Compare
Contributor
|
@swift-ci smoke test |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR improves the in-source docs of the
PackageDescriptionAPI for better readability and clarity.