From fd0961fce9b5fad6fae62245e7735da3927b4249 Mon Sep 17 00:00:00 2001
From: Emma K Alexandra <emma@emma.sh>
Date: Thu, 14 Mar 2024 22:01:52 -0400
Subject: [PATCH] fix: documentation errors

ci: update to node 20 actions
---
 .github/workflows/docs.yml         | 10 +++++-----
 Sources/MetroGTFS/Error.swift      |  2 +-
 Sources/MetroGTFS/Stop+WMATA.swift |  5 ++++-
 Sources/MetroGTFS/Stop.swift       |  7 +++----
 4 files changed, 13 insertions(+), 11 deletions(-)

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
index a8cd0771..85898b8b 100644
--- a/.github/workflows/docs.yml
+++ b/.github/workflows/docs.yml
@@ -22,11 +22,11 @@ jobs:
     runs-on: macos-latest
 
     steps:
-    - uses: actions/checkout@v3
+    - uses: actions/checkout@v4
     - name: Set up Pages
-      uses: actions/configure-pages@v1
+      uses: actions/configure-pages@v4
     - name: Set up Swift
-      uses: fwal/setup-swift@v1
+      uses: fwal/setup-swift@v2
       with:
         swift-version: '5.9'
     - name: Generate Docs
@@ -37,7 +37,7 @@ jobs:
         disable-indexing: 'true'
         hosting-base-path: WMATA.swift
     - name: Upload artifact
-      uses: actions/upload-pages-artifact@v1
+      uses: actions/upload-pages-artifact@v3
       with:
         path: ./public
 
@@ -50,4 +50,4 @@ jobs:
 
     steps:
     - name: Deploy Docs
-      uses: actions/deploy-pages@v1
+      uses: actions/deploy-pages@v4
diff --git a/Sources/MetroGTFS/Error.swift b/Sources/MetroGTFS/Error.swift
index 865bbe0b..7d94dc6c 100644
--- a/Sources/MetroGTFS/Error.swift
+++ b/Sources/MetroGTFS/Error.swift
@@ -21,7 +21,7 @@ public enum GTFSDatabaseError: Error {
     /// Note that in the SQLite wrapper MetroGTFS uses, a Table is the data type used to represent a query.
     case unableToPerformQuery(Table)
     
-    /// The given rows does is not valid and could not be loaded. Usually associated with some ``MetroGTFS/GTFS/DatabaseDecodingError``.
+    /// The given rows does is not valid and could not be loaded. Usually associated with some ``GTFSDatabaseDecodingError``.
     case invalid(Row)
 }
 
diff --git a/Sources/MetroGTFS/Stop+WMATA.swift b/Sources/MetroGTFS/Stop+WMATA.swift
index 0345f583..5da38db4 100644
--- a/Sources/MetroGTFS/Stop+WMATA.swift
+++ b/Sources/MetroGTFS/Stop+WMATA.swift
@@ -10,7 +10,10 @@
 import WMATA
 
 public extension GTFSStop {
-    /// Create a GTFS Stop from a ``Station``
+    /// Create a GTFS Stop from a WMATA `Station`.
+    ///
+    /// - Parameters:
+    ///   - station: A WMATA package station
     init(station: Station) throws {
         try self.init(id: .init("STN_\(station.rawValue)"))
     }
diff --git a/Sources/MetroGTFS/Stop.swift b/Sources/MetroGTFS/Stop.swift
index 78202fef..fc764edd 100644
--- a/Sources/MetroGTFS/Stop.swift
+++ b/Sources/MetroGTFS/Stop.swift
@@ -30,7 +30,6 @@ public struct GTFSStop: Equatable, Hashable, Codable {
     /// - `PLF_B05_RD_SHADY_GROVE` - Platform at Brookland-CUA on the Red Line to Shady Grove
     ///
     /// ## Notes
-    /// - For stations, this ID is typically identical to a ``Station``
     /// - For transfer stations, both `Station` IDs are included. Example: `STN_D03_F03`.
     public var id: GTFSIdentifier<GTFSStop>
     
@@ -77,7 +76,7 @@ public struct GTFSStop: Equatable, Hashable, Codable {
         /// A location within a station, not matching any other `Location`, that may be used to link together pathways.
         ///
         /// ## Notes
-        /// Unfortunately, WMATA uses this value for platforms instead of ``GTFS/Stop/Location/platform``. Also used for elevator and escalator landings.
+        /// Unfortunately, WMATA uses this value for platforms instead of  ``platform``. Also used for elevator and escalator landings.
         case genericNode = 3
         
         /// A specific location on a platform, where passengers can board and/or alight vehicles.
@@ -90,7 +89,7 @@ public struct GTFSStop: Equatable, Hashable, Codable {
     /// If this stop is a Platform, Station, Entrance, or some other type of location.
     public var locationType: LocationType
     
-    /// If this stop is location within some other ``GTFS/Stop``
+    /// If this stop is location within some other ``GTFSStop``
     public var parentStation: GTFSIdentifier<GTFSStop>?
     
     /// Indicates whether wheelchair boardings are possible from the location.
@@ -109,7 +108,7 @@ public struct GTFSStop: Equatable, Hashable, Codable {
     /// Indicates whether wheelchair boardings are possible from the location.
     public var wheelchairBoarding: WheelchairBoarding
     
-    /// ``GTFS/Level`` of the location. The same level may be used by multiple unlinked stations.
+    /// ``GTFSLevel`` of the location. The same level may be used by multiple unlinked stations.
     public var level: GTFSIdentifier<GTFSLevel>?
     
     /// Create a new Stop by providing all of it's fields