Apply Apple developer-content-guidelines style fixes to the new
"Implementing a Custom Distributed Actor System" article and the
Distributed module landing page that was updated alongside it.
Correctness fixes:
- Typos: "obtain as remote reference" -> "a", "process it that" -> "if",
"DistributedAtor" -> "DistributedActor", "remot ecall" -> "remote call",
"nerworking" -> "networking", "comains" -> "domains", "distribute actors"
-> "distributed actors".
- Heading "Receive and Execute an RemoteInvocation" had article disagreement
and a fake-symbol reference; rename to "Receive and execute a remote
invocation".
- remoteCall and remoteCallVoid used withCheckedContinuation but called
resume(throwing:); switch to withCheckedThrowingContinuation so the
examples compile.
- Removed unsupported claim that the sample encoder uses mangled names;
recordGenericSubstitution is empty in the shown code.
- Distributed-collection.md referenced [cluster] but only [runtime] was
defined; rename the reference to match.
- Demoted the broken Codable DocC symbol link to a plain code span (Codable
lives in the standard library, not the Distributed module).
Editorial pass:
- Convert future tense, first-person plural, and hedging constructions
("we", "will", "would", "should", "able to", "may also") to present-tense,
second-person, active voice throughout.
- Convert section headings to sentence case.
- Normalize code-block indentation to four spaces; strip trailing whitespace.
- Code-comment hygiene: capitalize first word, end with periods, ID instead
of id, "for example" instead of "e.g."
- Fix bullet-list parallelism in the Overview.
- Replace the misleading "returns a remote reference" comment in the
Greeter example with an honest note that both sides share one in-process
system.
- Replace the trailing opinion paragraphs with a recap of what the reader
built and cross-links to DistributedActorSystem and
LocalTestingDistributedActorSystem.
- Normalize DocC link grain to fully qualified Distributed/... form; add a
symbol link to DistributedTargetInvocationResultHandler in the
"Report results and errors" section.
- Drop the misleading "also called a cluster runtime" gloss on
DistributedActorSystem in the collection page, since the new article makes
clear the protocol is broader than clusters.
As we now have docc doc catalogues and can have articles since
https://github.com/swiftlang/swift/pull/88061, we finally have a place
to put distributed actor system documentation!
These new icons match the color, font, and general appearance of the
default icons in the documentation navigator sidebar, used for other
kinds of symbols (classes, protocols, methods, etc.).
rdar://174344255
Joe Heck
Konrad `ktoso` Malawski
David Rönnqvist
Iliya Lyan
Graham Lee