Resolve all current code warnings except the one about NIO #1148
Conversation
|
@swift-ci please test |
|
@swift-ci please test |
| @@ -44,7 +44,6 @@ for language in swift-or-c bash md-or-tutorial html docker; do | |||
| declare -a matching_files | |||
| declare -a exceptions | |||
| declare -a reader | |||
| expections=( ) | |||
There was a problem hiding this comment.
Unrelated to this PR: it might be worth documenting the purpose and features of this script a bit. It seems useful and important, but some contributors might not be aware it exists or ever run it except as part of the bin/test.sh script.
| @@ -136,6 +135,7 @@ EOF | |||
| cd "$here/.." | |||
| find . \ | |||
| \( \! -path './.build/*' -a \ | |||
| \! -path './bin/benchmark/.build/*' -a \ | |||
There was a problem hiding this comment.
Does this resolve a specific warning?
There was a problem hiding this comment.
It resolves warnings about several files in Swift-Markdown that don't have the license header comment that DocC expects.
Currently, anyone who runs the benchmark tools (even just to read the help text) have to delete that build directory in order for bin/test to pass locally. This fixes that.
| @@ -119,7 +119,12 @@ public class NavigatorTree { | |||
|
|
|||
| func __read() { | |||
| let deadline = DispatchTime.now() + timeout | |||
| #if swift(>=5.10) | |||
| // Access to this local variable is synchronized using the DispatchQueue `queue`, passed as an argument. | |||
There was a problem hiding this comment.
Thanks for the explanation here.
| _renderNodeProvider as! RenderNodeProvider? | ||
| } | ||
| // This property only exist to be able to assign `nil` to `renderNodeProvider` in the new initializer without causing a deprecation warning. | ||
| private let _renderNodeProvider: Any? |
There was a problem hiding this comment.
Thanks for the comment here; maybe also explain the use of Any is required to avoid the warning as well.
There was a problem hiding this comment.
For code that's scheduled to be removed I feel that this is fine. The general oddity of the declaration is explained by the comment above and anyone who tries to change the type will notice that doing so reintroduces the deprecation warning.
|
@swift-ci please test |
|
@swift-ci please test |
Bug/issue #, if applicable:
Summary
This is the same changes as #1143 except that it doesn't include the Swift NIO update (so one warning remains in the project)
Dependencies
None.
Testing
Build DocC. There should only be 1 code warning.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/testscript and it succeeded