New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[SR-7512] Documentation omits required conformances #50054
Comments
That sounds like an issue with Apple's docs rather than with anything in the Swift Open Source project. Can you file this at https://bugreport.apple.com instead? |
The text of Apple’s documentation appears to be taken verbatim from the doc-comments on the Here is the Note in particular that the doc-comment for the That is clearly incorrect, because the method is inside an extension constrained to I can go ahead an submit a PR to fix the documentation, unless someone else is in charge of that. |
Ah, sure, changing the doc text is covered by this, and a PR is definitely welcome. It's still worth filing a Radar, though, so that the Apple docs page can include the constraints on the method and not just its enclosing protocol. |
It's not generally the responsibility of a doc comment to repeat the constraints that are already in the declaration, but it shouldn't get them wrong. |
I filed Radar 40980314 for the Apple documentation issue. I used the new |
Additional Detail from JIRA
md5: c68ce4065abf48d06f2d4c130d172c61
Issue Description:
The
MutableCollection
methodssort()
andsort(by:)
are constrained to requireRandomAccessCollection
conformance. However, the documentation for them makes no mention ofRandomAccessCollection
. That documentation should be improved to include the constraints on their availability.The text was updated successfully, but these errors were encountered: