Skip to content

Commit 5feba1b

Browse files
authored
Documentation fix (#1221)
1 parent d4b28c4 commit 5feba1b

File tree

2 files changed

+3
-3
lines changed

2 files changed

+3
-3
lines changed

Sources/DistributedCluster/ActorID.swift

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -619,7 +619,7 @@ extension _PathRelationships {
619619
/// to confirm whether or not a specific actor is the child of another another (identified by another unique path).
620620
/// Such relationships must be confirmed by using the `_ActorContext.children.hasChild(:UniqueActorPath)` method. TODO: this does not exist yet
621621
///
622-
/// - Parameter path: The path that is suspected to be the parent of `self`
622+
/// - Parameter maybeParentPath: The path that is suspected to be the parent of `self`
623623
/// - Returns: `true` if this [ActorPath] is a direct descendant of `maybeParentPath`, `false` otherwise
624624
public func isChildPathOf(_ maybeParentPath: _PathRelationships) -> Bool {
625625
Array(self.segments.dropLast()) == maybeParentPath.segments // TODO: more efficient impl, without the copying
@@ -631,7 +631,7 @@ extension _PathRelationships {
631631
/// to confirm whether or not a specific actor is the child of another another (identified by another unique path).
632632
/// Such relationships must be confirmed by using the `_ActorContext.children.hasChild(:UniqueActorPath)` method. TODO: this does not exist yet
633633
///
634-
/// - Parameter path: The path that is suspected to be a child of `self`
634+
/// - Parameter maybeChildPath: The path that is suspected to be a child of `self`
635635
/// - Returns: `true` if this [ActorPath] is a direct ancestor of `maybeChildPath`, `false` otherwise
636636
public func isParentOf(_ maybeChildPath: _PathRelationships) -> Bool {
637637
maybeChildPath.isChildPathOf(self)

Sources/DistributedCluster/AsyncResult.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ internal protocol _AsyncResult {
4343
/// be removed, so the lesser of the two timeouts will be the effective timeout
4444
/// value for the returned `_AsyncResult`.
4545
///
46-
/// - parameter after: defines a timeout after which the result should be considered failed.
46+
/// - parameter timeout: defines a timeout after which the result should be considered failed.
4747
func withTimeout(after timeout: Duration) -> Self
4848
}
4949

0 commit comments

Comments
 (0)