Skip to content

[SE-0263] Add test, rename API, update docs #30180

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.

Sign up for GitHub

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
Merged
merged 3 commits into from
Mar 6, 2020
Merged

[SE-0263] Add test, rename API, update docs #30180

merged 3 commits into from
Mar 6, 2020

Conversation

benrimmington
Copy link
Contributor

  • Add test for public API
  • Rename internal API (by adding leading underscore)
  • Update documentation (example code and parameters)

@benrimmington
Copy link
Contributor Author

Cc: @Catfish-Man, @milseman

milseman
milseman approved these changes Mar 4, 2020
View reviewed changes
Copy link
Member

@milseman milseman left a comment

Choose a reason for hiding this comment

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

Overall LGTM, but want @Catfish-Man 's thoughts on testing coverage and @natecook1000 's thoughts on documentation conventions.

stdlib/public/core/String.swift Outdated
Copy link
Member

Choose a reason for hiding this comment

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

LGTM, this seems like it will be a pattern we follow when we introduce new, availability-guarded public functionality that we also want to use internally.

natecook1000
natecook1000 reviewed Mar 4, 2020
View reviewed changes
@benrimmington
Copy link
Contributor Author

benrimmington commented Mar 4, 2020 •
edited
Loading

@natecook1000 I've used cafe1 and cafe2 (also found elsewhere in the documentation) to keep within the 80 character limit. (348c68f46550c8a7fd23b8e75006f50cb8396b9d)

@benrimmington
Copy link
Contributor Author

@milseman I've tested the code sample for better coverage. (81e5271b57399aa3e5d7f78308fcd48c888a9a50)

@milseman
Copy link
Member

milseman commented Mar 5, 2020

@swift-ci please test

@swift-ci
Copy link
Contributor

swift-ci commented Mar 5, 2020

Build failed
Swift Test Linux Platform
Git Sha - 34ff49ffc74a41cb64e4040343c2784779544a92

@swift-ci
Copy link
Contributor

swift-ci commented Mar 5, 2020

Build failed
Swift Test OS X Platform
Git Sha - 34ff49ffc74a41cb64e4040343c2784779544a92

@benrimmington
Copy link
Contributor Author

All checks have passed!

@milseman milseman merged commit 8d5d381 into swiftlang:master Mar 6, 2020
@benrimmington benrimmington deleted the se-0263-test branch March 6, 2020 20:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@milseman milseman milseman approved these changes

@natecook1000 natecook1000 natecook1000 approved these changes

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

Successfully merging this pull request may close these issues.
4 participants
@benrimmington @milseman @swift-ci @natecook1000