stdlib: add more doc comments to MutableIndexable

This commit is contained in:
Dmitri Gribenko
2016-03-19 00:03:03 -07:00
parent 95d2e11e7e
commit e63374f2b7

View File

@@ -11,7 +11,13 @@
//===----------------------------------------------------------------------===//
/// A type that supports subscript assignment to a mutable collection.
///
/// - Important: In most cases, it's best to ignore this protocol and use
/// `CollectionType` instead, as it has a more complete interface.
public protocol MutableIndexable : Indexable {
// FIXME(ABI)(compiler limitation): there is no reason for this protocol
// to exist apart from missing compiler features that we emulate with it.
//
// This protocol is almost an implementation detail of the standard
// library; it is used to deduce things like the `SubSequence` and
// `Iterator` type from a minimal collection, but it is also used in