Skip to content

[stdlib] Clean up various documentation issues #3804

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

Merged
merged 7 commits into from
Jul 28, 2016

Conversation

natecook1000
Copy link
Member

@natecook1000 natecook1000 commented Jul 27, 2016

What's in this pull request?

This corrects a variety of issues with documentation formatting, completion, and code samples.

Resolved bug number: n/a


Before merging this pull request to apple/swift repository:

  • Test pull request on Swift continuous integration.

Triggering Swift CI

The swift-ci is triggered by writing a comment on this PR addressed to the GitHub user @swift-ci. Different tests will run depending on the specific comment that you use. The currently available comments are:

Smoke Testing

Platform Comment
All supported platforms @swift-ci Please smoke test
All supported platforms @swift-ci Please smoke test and merge
OS X platform @swift-ci Please smoke test OS X platform
Linux platform @swift-ci Please smoke test Linux platform

A smoke test on macOS does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library only for macOS. Simulator standard libraries and
    device standard libraries are not built.
  3. lldb is not built.
  4. The test and validation-test targets are run only for macOS. The optimized
    version of these tests are not run.

A smoke test on Linux does the following:

  1. Builds the compiler incrementally.
  2. Builds the standard library incrementally.
  3. lldb is built incrementally.
  4. The swift test and validation-test targets are run. The optimized version of these
    tests are not run.
  5. lldb is tested.

Validation Testing

Platform Comment
All supported platforms @swift-ci Please test
All supported platforms @swift-ci Please test and merge
OS X platform @swift-ci Please test OS X platform
OS X platform @swift-ci Please benchmark
Linux platform @swift-ci Please test Linux platform

Lint Testing

Language Comment
Python @swift-ci Please Python lint

Note: Only members of the Apple organization can trigger swift-ci.

@natecook1000
Copy link
Member Author

@swift-ci Please test

@gottesmm
Copy link
Contributor

These are all documentation changes. Does it really need a full test?

@natecook1000
Copy link
Member Author

@gottesmm I think it does, unfortunately. There are some validation tests (at least one?) that check that SourceKit is doing the right thing by verifying the documentation of standard library types.

@natecook1000
Copy link
Member Author

Maybe just one platform would suffice in the future, though?

@gottesmm
Copy link
Contributor

Sure. SGTM. Just use common sense here.

@tkremenek tkremenek merged commit 58fb4ef into swiftlang:master Jul 28, 2016
@natecook1000 natecook1000 deleted the nc-fixes-02 branch November 1, 2016 19:37
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.

3 participants