Skip to content

Commit d58e88f

Browse files
RISCfutureclaude
andcommitted
Apply markdownlint formatting to docs
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
1 parent f64abe4 commit d58e88f

5 files changed

Lines changed: 45 additions & 46 deletions

File tree

CHANGELOG.md

Lines changed: 22 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -70,58 +70,58 @@ Swift 6 concurrency mode
7070

7171
### API Changes
7272

73-
* Removes Combine and callback concurrency models in favor of exclusively
73+
- Removes Combine and callback concurrency models in favor of exclusively
7474
`async`/`await`
75-
* Removes `ConcurrentDistribution` protocol (now redundant)
76-
* Marks loaders and distribution classes as `final` and `Sendable`
77-
* Adds `FileReadActor` to control synchronous access to a distribution's files
78-
* Converts record types (airport, navaid, etc.) into structs for concurrency
75+
- Removes `ConcurrentDistribution` protocol (now redundant)
76+
- Marks loaders and distribution classes as `final` and `Sendable`
77+
- Adds `FileReadActor` to control synchronous access to a distribution's files
78+
- Converts record types (airport, navaid, etc.) into structs for concurrency
7979
guarantees
80-
* Adds `Record` and `ParentRecord` protocols describing parsed records
81-
* Makes record types `Sendable` and `Codable`
82-
* Makes parent record types `Hashable`, `Equatable`, and `Identifiable`
83-
* Converts `NASR` and `NASRData` to actors
84-
* Adds `NASRDataCodable` to preserve `Codable` support for `NASRData`
85-
* Advances minimum OS versions
80+
- Adds `Record` and `ParentRecord` protocols describing parsed records
81+
- Makes record types `Sendable` and `Codable`
82+
- Makes parent record types `Hashable`, `Equatable`, and `Identifiable`
83+
- Converts `NASR` and `NASRData` to actors
84+
- Adds `NASRDataCodable` to preserve `Codable` support for `NASRData`
85+
- Advances minimum OS versions
8686

8787
### Documentation Changes
8888

89-
* Updates documentation
90-
* NOTE: A current bug in Swift-DocC is preventing some articles from showing
89+
- Updates documentation
90+
- NOTE: A current bug in Swift-DocC is preventing some articles from showing
9191
in the sidebar
9292

9393
### Test Changes
9494

95-
* Updates tests to use async model
96-
* Rewrites the E2E test app
95+
- Updates tests to use async model
96+
- Rewrites the E2E test app
9797

9898
## [0.3.0] - 2024-09-24
9999

100100
Updated Swift Tools version to 6.0 (stil using language version 5).
101101

102102
### Breaking Changes
103103

104-
* `ARTCC`: ICAO ID is now optional.
104+
- `ARTCC`: ICAO ID is now optional.
105105

106106
### API Changes
107107

108-
* ISO-Latin1 encoding is used when parsing distribution text files.
109-
* Moved from `NSLocalizedString` to string catalogs.
110-
* `Runway`: Added a gradient estimation method that uses the base and reciprocal
108+
- ISO-Latin1 encoding is used when parsing distribution text files.
109+
- Moved from `NSLocalizedString` to string catalogs.
110+
- `Runway`: Added a gradient estimation method that uses the base and reciprocal
111111
elevations (when known). You can use this is a stopgap until the FAA resumes
112112
distributing runway gradient data.
113-
* Dependency updates.
113+
- Dependency updates.
114114

115115
## [0.2.0] - 2024-05-16
116116

117117
Updated ZIPFoundation dependency.
118118

119119
### Breaking Changes
120120

121-
* The `ArchiveFileDistribution` and `ArchiveDataDistribution` initializers no
121+
- The `ArchiveFileDistribution` and `ArchiveDataDistribution` initializers no
122122
longer return `nil` if the archive could not be read; instead, they rethrow
123123
the error thrown by ZIPFoundation.
124-
* The `ArchiveFileDownloader` and `ArchiveDataDownloader`'s `load` methods no
124+
- The `ArchiveFileDownloader` and `ArchiveDataDownloader`'s `load` methods no
125125
longer throw `Error.badData`; instead they rethrow the error thrown by
126126
ZIPFoundation.
127127

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ likely to generate parsing errors, and require more developer work to maintain f
2727
compatibility -- but it also results in a library that's more in harmony with the design goals
2828
of the Swift language itself (type safety, compile-time checks, etc.).
2929

30-
### What records can I parse with this?
30+
## What records can I parse with this?
3131

3232
SwiftNASR parses all record types in a NASR distribution:
3333

@@ -149,7 +149,7 @@ more information.
149149
## Documentation
150150

151151
Online API documentation and tutorials are available at
152-
https://riscfuture.github.io/SwiftNASR/documentation/swiftnasr/
152+
<https://riscfuture.github.io/SwiftNASR/documentation/swiftnasr/>
153153

154154
DocC documentation is available, including tutorials and API documentation. For
155155
Xcode documentation, you can run

Sources/SwiftNASR/Documentation.docc/RunwayEnd.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,3 @@
8080
- ``MarkingCondition-swift.enum``
8181
- ``RVRSensor``
8282
- ``ApproachLighting-swift.enum``
83-

Sources/SwiftNASR/Documentation.docc/Working with Distributions.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -68,23 +68,23 @@ for more information.
6868

6969
### Downloading Distributions
7070

71-
- ``NASR/fromInternetToMemory(activeAt:format:)``
72-
- ``ArchiveDataDistribution``
73-
- ``NASR/fromInternetToFile(_:activeAt:format:)``
74-
- ``ArchiveFileDistribution``
71+
* ``NASR/fromInternetToMemory(activeAt:format:)``
72+
* ``ArchiveDataDistribution``
73+
* ``NASR/fromInternetToFile(_:activeAt:format:)``
74+
* ``ArchiveFileDistribution``
7575

7676
### Loading Distributions from Disk
7777

78-
- ``NASR/fromLocalArchive(_:format:)``
79-
- ``ArchiveFileDistribution``
80-
- ``NASR/fromLocalDirectory(_:format:)``
81-
- ``DirectoryDistribution``
78+
* ``NASR/fromLocalArchive(_:format:)``
79+
* ``ArchiveFileDistribution``
80+
* ``NASR/fromLocalDirectory(_:format:)``
81+
* ``DirectoryDistribution``
8282

8383
### Loading Parsed Data
8484

85-
- ``NASR/fromData(_:)``
86-
- ``NullDistribution``
85+
* ``NASR/fromData(_:)``
86+
* ``NullDistribution``
8787

8888
### Subclassing
8989

90-
- ``Distribution``
90+
* ``Distribution``

Sources/SwiftNASR/Documentation.docc/Working with Loaders.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -50,19 +50,19 @@ documentation for more information.
5050

5151
### Downloading Distributions
5252

53-
- ``NASR/fromInternetToMemory(activeAt:format:)``
54-
- ``ArchiveDataDistribution``
55-
- ``NASR/fromInternetToFile(_:activeAt:format:)``
56-
- ``ArchiveFileDistribution``
53+
* ``NASR/fromInternetToMemory(activeAt:format:)``
54+
* ``ArchiveDataDistribution``
55+
* ``NASR/fromInternetToFile(_:activeAt:format:)``
56+
* ``ArchiveFileDistribution``
5757

5858
### Loading Distributions from Disk
5959

60-
- ``NASR/fromLocalArchive(_:format:)``
61-
- ``ArchiveFileDistribution``
62-
- ``NASR/fromLocalDirectory(_:format:)``
63-
- ``DirectoryDistribution``
60+
* ``NASR/fromLocalArchive(_:format:)``
61+
* ``ArchiveFileDistribution``
62+
* ``NASR/fromLocalDirectory(_:format:)``
63+
* ``DirectoryDistribution``
6464

6565
### Subclassing
6666

67-
- ``Loader``
68-
- ``Downloader``
67+
* ``Loader``
68+
* ``Downloader``

0 commit comments

Comments
 (0)