averello/swift-mirror
1
0
Fork 0
mirror of https://github.com/apple/swift.git synced 2025-12-21 12:14:44 +01:00
Code Issues Packages Projects Releases Wiki Activity

stdlib: Convert comments to use '- requires:' instead of 'Requires:'.

Browse Source 
Tidy misc. comments and markdown along the way.

Patch by Brian Lanier.

Swift SVN r28473
This commit is contained in:
Dmitri Hrybenko
2015-05-12 17:47:11 +00:00
parent 5c55682d8b
commit 68ef59e37a
44 changed files with 281 additions and 264 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
stdlib/public/core/SequenceAlgorithms.swift.gyb
View File

@@ -51,8 +51,9 @@ extension SequenceType {
%{
if preds:
orderingRequirement = """
/// Requires: `isOrderedBefore` is a [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings).
/// over `self`."""
/// - Requires: `isOrderedBefore` is a
/// [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings).
/// over `self`."""
else:
orderingRequirement = ""
}%
@@ -122,7 +123,8 @@ if preds:
/// `other`, using `isEquivalent` as the equivalence test. Return true if
/// `other` is empty.
///
/// Requires: `isEquivalent` is an [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)"""
/// - Requires: `isEquivalent` is an
/// [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)."""
else:
comment = """
/// Return true iff the the initial elements of `self` are equal to `prefix`.
@@ -170,7 +172,8 @@ if preds:
/// Return true iff `self` and `other` contain equivalent elements, using
/// `isEquivalent` as the equivalence test.
///
/// Requires: `isEquivalent` is an [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)"""
/// - Requires: `isEquivalent` is an
/// [equivalence relation](http://en.wikipedia.org/wiki/Equivalence_relation)."""
else:
comment = """
/// Return `true` iff `self` and `other` contain the same elements in the
@@ -231,8 +234,9 @@ if preds:
/// to present to the end-user, you should use `String` APIs that perform
/// localized comparison.
///
/// Requires: `isOrderedBefore` is a [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings)
/// over the elements of `self` and `other`."""
/// - Requires: `isOrderedBefore` is a
/// [strict weak ordering](http://en.wikipedia.org/wiki/Strict_weak_order#Strict_weak_orderings)
/// over the elements of `self` and `other`."""
else:
comment = """
/// Return true iff `self` precedes `other` in a lexicographical ("dictionary")