[stdlib] Revise documentation comments #17109
Merged
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
Member
natecook1000
commented
Jun 11, 2018
natecook1000
commented
- Clarify RawValue requirement for OptionSet
- Make Bool counterexample more clearly an error
- Add clarifying note about unsafe arithmetic methods
- Add/refine complexity docs for sequence/collection
stdlib/public/core/Collection.swift
Outdated
| /// | ||
| /// - Complexity: O(1) if the collection conforms to | ||
| /// `RandomAccessCollection`; otherwise, O(*n*), where *n* is the absolute | ||
| /// value of `n`. |
There was a problem hiding this comment.
Shouldn't this be "where n is the length of the collection"? (same for the default implementations of randomElement(using:) and randomElement()) I'm not sure it's clear what n refers to otherwise.
There was a problem hiding this comment.
Wow, thanks — that's definitely the wrong boilerplate.
natecook1000
force-pushed
the
nc-fixes-86-1
branch
from
1fc6ae9 to
4836bb5
Compare
|
@swift-ci Please smoke test |
airspeedswift
approved these changes
Jun 13, 2018
natecook1000
force-pushed
the
nc-fixes-86-1
branch
from
4836bb5 to
aed532b
Compare
|
I'm separating out the complexity annotation changes for their own review. |
|
@swift-ci Please smoke test |
|
@swift-ci Please smoke test macOS platform |
- Clarify RawValue requirement for OptionSet - Make Bool counterexample more clearly an error - Add clarifying note about unsafe arithmetic methods - Add/refine complexity docs for sequence/collection - Remove docs from obsoleted symbols - Standardize on unicode.org for links about Unicode - More complexity annotations - Expand dictionary defaulted subscript docs - Fix error in Dictionary.init(minimumCapacity:) docs - Improve accuracy of prime number listing
natecook1000
force-pushed
the
nc-fixes-86-1
branch
from
aed532b to
653a4d8
Compare
|
@swift-ci Please smoke test and merge |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.