Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit 859d9b9

Browse files
committed
Update section about swiftdoc.org
1 parent 7784bef commit 859d9b9

File tree

1 file changed

+18
-16
lines changed

1 file changed

+18
-16
lines changed

README.md

Lines changed: 18 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -151,10 +151,10 @@ $ swift run swift-dcov SwiftSemantics/Sources/ | jq ".data.symbols[] | select(.d
151151
While there are plenty of tools for assessing test coverage for code,
152152
we weren't able to find anything analogous for documentation coverage.
153153
To this end,
154-
we've contrived a simple JSON format
154+
we've contrived a simple JSON format
155155
[inspired by llvm-cov](https://reviews.llvm.org/D22651#change-xdePaVfBugps).
156156

157-
If you know of an existing standard
157+
If you know of an existing standard
158158
that you think might be better suited for this purpose,
159159
please reach out by [opening an Issue][open an issue]!
160160

@@ -183,7 +183,7 @@ you can feed the output of `swift-api-inventory` to conventional diffing tools
183183
to determine API changes between different releases of a project.
184184

185185
For example,
186-
here's an API diff between the first beta and latest release candidate of
186+
here's an API diff between the first beta and latest release candidate of
187187
[Alamofire 5](https://forums.swift.org/t/alamofire-5-one-year-in-the-making-now-in-beta/18865):
188188

189189
```terminal
@@ -245,7 +245,7 @@ digraph Anonymous {
245245
"URLEncodedFormEncoder" [shape=box,peripheries=2];
246246
"ServerTrustManager" [shape=box];
247247
"MultipartFormData" [shape=box];
248-
248+
249249
subgraph cluster_Request {
250250
"DataRequest" [shape=box];
251251
"Request" [shape=box];
@@ -267,13 +267,13 @@ for both Swift and Objective-C projects.
267267
Over time, however,
268268
the way we write Swift code —
269269
and indeed the language itself —
270-
has evolved to incorporate patterns and features
271-
that are difficult to understand using
270+
has evolved to incorporate patterns and features
271+
that are difficult to understand using
272272
the same documentation standards that served us well for Objective-C.
273273

274274
Whereas in Objective-C,
275275
you could get a complete view of a type's functionality from its class hierarchy,
276-
Swift code today tends to layer and distribute functionality across
276+
Swift code today tends to layer and distribute functionality across
277277
[a network of types][swift number protocols diagram].
278278
While adopting a
279279
[protocol-oriented paradigm][protocol-oriented programming]
@@ -285,7 +285,7 @@ is to make Swift documentation more useful
285285
by surfacing the information you need to understand how an API works
286286
and presenting it in a way that can be easily searched and accessed.
287287
We want developers to be empowered to use Swift packages to their full extent,
288-
without being reliant on (often outdated) blog posts or Stack Overflow threads.
288+
without being reliant on (often outdated) blog posts or Stack Overflow threads.
289289
We want documentation coverage to become as important as test coverage:
290290
a valuable metric for code quality,
291291
and an expected part of first-rate open source projects.
@@ -334,7 +334,7 @@ Because it relies only on a syntactic reading of Swift source code,
334334
without needing code first to be compiled,
335335
`swift-doc` is quite fast.
336336
As a baseline,
337-
compare its performance to Jazzy
337+
compare its performance to Jazzy
338338
when generating documentation for [SwiftSemantics][swiftsemantics]:
339339

340340
```terminal
@@ -361,17 +361,19 @@ to [a GitHub wiki generated with `swift-doc`][swift-doc swiftsemantics].
361361

362362
## What About [SwiftDoc.org][swiftdoc.org]?
363363

364-
**tl;dr:**
365-
We're currently working on updating SwiftDoc.org for Swift 5,
366-
and hope to have it released later this week.
364+
**tl;dr:**
365+
SwiftDoc.org is now updated for Swift 5.1,
366+
but we're still working to migrate over a few missing parts
367+
(notably, the beloved
368+
[type inheritance graphs](https://swiftdoc.org/v4.2/protocol/expressiblebyfloatliteral/hierarchy/)).
367369

368370
SwiftDoc.org,
369371
[originally "Swifter"](http://natecook.com/blog/2014/09/introducing-swifter/),
370-
was created by Nate Cook ([@natecook1000][@natecook1000])
372+
was created by Nate Cook ([@natecook1000][@natecook1000])
371373
in September 2014.
372374
At the time,
373375
Swift tooling was still in its infancy,
374-
so Nate actually
376+
so Nate actually
375377
[wrote a parser (from scratch!)](https://github.com/SwiftDocOrg/swiftdoc-parser)
376378
to pull symbols and documentation from the Swift standard library.
377379
Nate became managing editor of [NSHipster][nshipster] in 2015,
@@ -383,9 +385,9 @@ After the hand-off,
383385
we were able to get the site updated for Swift 4.2 without too much trouble.
384386
But when it came time to regenerate the site for Swift 5,
385387
we found ourselves deep in ["dependency hell"][dependency hell]
386-
(something to do with the [regular expression][pcre] library
388+
(something to do with the [regular expression][pcre] library
387389
that Nate had used for the parser).
388-
After begging and pleading with
390+
After begging and pleading with
389391
the spirits possessing our `node_modules` directory to no avail,
390392
we decided to roll up our sleeves and get started on a long-term replacement —
391393
this time, written in Swift.

0 commit comments

Comments
 (0)