[GHA] Documentation check #2764

FranzBusch · 2024-07-04T13:04:52Z

Motivation

Next up replacing the documentation check.

Modification

This moves the current approach of the script into a GH action. I tried just running the documentation check against all targets but that also results in warnings from downstream deps in their docs to show up.

I also fixed up some new errors that appeared since our current pipeline was running on 5.8.

Result

Next CI job migrated to GHA

PeterAdams-A · 2024-07-04T13:15:05Z

Sources/NIOCore/EventLoop.swift

@@ -314,7 +314,7 @@ public protocol EventLoop: EventLoopGroup {
    /// This executor can be used to isolate an actor to a given ``EventLoop``. Implementers are encouraged to customise
    /// this implementation by conforming their ``EventLoop`` to ``NIOSerialEventLoopExecutor`` which will provide an
    /// optimised implementation of this method, and will conform their type to `SerialExecutor`. The default
-    /// implementation returns a ``NIODefaultSerialEventLoopExecutor`` instead, which provides suboptimal performance.
+    /// implementation provides suboptimal performance.


Feels like we're losing info here. Perhaps that information would be better in a regular comment more than a doc comment though.

I think we leaked implementation details here before. NIODefault...Executor is internal and we shouldn't talk about it in public docs.

PeterAdams-A · 2024-07-04T13:15:35Z

Sources/NIOFileSystem/FileSystem.swift

@@ -656,7 +656,7 @@ public struct FileSystem: Sendable, FileSystemProtocol {
 extension NIOSingletons {
    /// A suggestion of how many threads the global singleton ``FileSystem`` uses for blocking I/O.
    ///
-    /// The thread count is ``System/coreCount`` unless the environment variable
+    /// The thread count is the systems core count unless the environment variable


Core count is slightly more complex than this as cgroup aware etc.

Perhaps not super important to drop this distinction though. Maybe available cores would be a better way of phrasing it.

# Motivation Next up replacing the documentation check. # Modification This moves the current approach of the script into a GH action. I tried just running the documentation check against all targets but that also results in warnings from downstream deps in their docs to show up. I also fixed up some new errors that appeared since our current pipeline was running on 5.8. # Result Next CI job migrated to GHA

FranzBusch added the semver/none No version bump required. label Jul 4, 2024

FranzBusch force-pushed the fb-gha-doc-check branch from 93748d4 to 06aa590 Compare July 4, 2024 13:07

PeterAdams-A reviewed Jul 4, 2024

View reviewed changes

FranzBusch force-pushed the fb-gha-doc-check branch from 06aa590 to 781cea2 Compare July 4, 2024 13:24

FranzBusch requested a review from glbrntt July 4, 2024 14:03

PeterAdams-A approved these changes Jul 4, 2024

View reviewed changes

glbrntt approved these changes Jul 4, 2024

View reviewed changes

FranzBusch merged commit 9730938 into main Jul 4, 2024
15 of 16 checks passed

FranzBusch deleted the fb-gha-doc-check branch July 4, 2024 15:21

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GHA] Documentation check #2764

[GHA] Documentation check #2764

FranzBusch commented Jul 4, 2024

PeterAdams-A Jul 4, 2024

FranzBusch Jul 4, 2024

PeterAdams-A Jul 4, 2024

PeterAdams-A Jul 4, 2024

[GHA] Documentation check #2764

[GHA] Documentation check #2764

Conversation

FranzBusch commented Jul 4, 2024

Motivation

Modification

Result

PeterAdams-A Jul 4, 2024

Choose a reason for hiding this comment

FranzBusch Jul 4, 2024

Choose a reason for hiding this comment

PeterAdams-A Jul 4, 2024

Choose a reason for hiding this comment

PeterAdams-A Jul 4, 2024

Choose a reason for hiding this comment