Remove doc comments from concrete floating-point types #26399
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
... when they are already present on the protocol. I don't *think* that we need them anymore for xcode documentation purposes. There are reasonable arguments both ways on this: 1. when you're editing the concrete implementations, it's sometimes nice to have the doc comment right there. 2. but it needlessly repetitive, and introduces the opportunity for comments to get out of sync. 3. it also adds noise; it would be nice for information density if the implementation only had implementation notes.
|
@swift-ci please test |
xwu
reviewed
Jul 30, 2019
In particular, document that subnormal encodings are treated as non-canonical zeros on platforms that flush to zero.
This one isn't a protocol requirement, so I was slightly overzealous removing it.
|
@swift-ci please smoke test |
|
@natecook1000 is on vacation this week, I'm going to wait to merge this until he has a chance to give it at least a cursory approval. |
natecook1000
reviewed
Aug 6, 2019
Co-Authored-By: Nate Cook <[email protected]>
Co-Authored-By: Nate Cook <[email protected]>
I don't think this is testable for Swift, since it's an Xcode thing, but it seems to work robustly in 11. In the documentation view, you get a little: |
|
Interesting, I hadn’t noticed that! |
|
@swift-ci please smoke test |
natecook1000
approved these changes
Aug 6, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
... when they are already present on the protocol. I don't think that we need them anymore for xcode documentation purposes. There are reasonable arguments both ways on this:
Also includes some minor formatting fixups, and a bugfix for isCanonical on platforms that do not support subnormals (armv7, currently, which is sufficiently minor that I'm OK with stealth fixing it like this).