Skip to content

Commit

Permalink
Fix README unavailable code
Browse files Browse the repository at this point in the history
  • Loading branch information
aabewhite committed Oct 9, 2023
1 parent 7c5dcac commit c122a6b
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The module is transparently adopted through the automatic addition of `import sk
## Status

- SkipLib's Swift symbol files (see [Implementation Strategy](#implementation-strategy)) are nominally complete. They should declare all Swift standard library API. This is difficult to validate, however, so if you find anything missing, please [report it](https://github.com/skiptools/skip-lib/issues) to us.
- Unimplemented API is appropriately marked with `@available(unavailable, *)` annotations. Skip will generate an error when you attempt to use an unimplemented API.
- Unimplemented API is appropriately marked with `@available(*, unavailable)` annotations. Skip will generate an error when you attempt to use an unimplemented API.
- In particular, a significant portion of the [collections](#collections) API is not yet implemented.
- Unit testing is not comprehensive. See [Tests](#tests) for the current test run status.

Expand All @@ -29,7 +29,7 @@ We welcome contributions to SkipLib. The Skip product documentation includes hel

The most pressing need is to reduce the amount of unimplemented API. To help fill in unimplemented API in SkipLib:

1. Find unimplemented API. Unimplemented API should be marked with `@available(unavailable, *)` in the Swift symbol files.
1. Find unimplemented API. Unimplemented API should be marked with `@available(*, unavailable)` in the Swift symbol files.
1. Write an appropriate Kotlin implementation. See [Implementation Strategy](#implementation-strategy) below. For [collections](#collections) API, make sure your implementation is duplicated for `String` as well.
1. Write unit tests.
1. [Submit a PR.](https://github.com/skiptools/skip-lib/pulls)
Expand Down

0 comments on commit c122a6b

Please sign in to comment.