apple / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.14k stars 118 forks source link

Lower severity of source-symbol-not-found diagnostic #966

Open d-ronnqvist opened 4 days ago

d-ronnqvist commented 4 days ago

Bug/issue #, if applicable:

Summary

This PR makes two changes to the diagnostic when the source symbol of a symbol graph relationship can't be found:

Since the solution to this issue is for the tool that created the symbol graph file to not include this relationship (or move it to a different file), it's safe for DocC to proceed without processing this symbol graph relationship.

Dependencies

None.

Testing

Checklist

Make sure you check off the following items. If they cannot be completed, provide a reason.

d-ronnqvist commented 4 days ago

@swift-ci please test

d-ronnqvist commented 4 days ago

After an offline discussion about this PR I've further reduced the severity to a debug-only assertion in https://github.com/apple/swift-docc/pull/966/commits/2e64b4be80cd5232f6d62d963ac265eb3514ecec.

d-ronnqvist commented 4 days ago

@swift-ci please test