Skip to content

Document the Augmented enum in RealModule in advance of 1.0 #181

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

Merged

Conversation

stephentyrone
Copy link
Member

No description provided.

@stephentyrone
Copy link
Member Author

@swift-ci test

@stephentyrone stephentyrone merged commit 17f5b59 into apple:main Aug 19, 2021
@stephentyrone
Copy link
Member Author

Cherry-picked to release/1.0.

/// This operation is sometimes called "twoProd" or "twoProduct".
///
/// Edge Cases:
/// -

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is a blank bullet here and also in some lists below. Is it intentional?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, this produces the desired formatting in Xcode:
Screen Shot 2021-08-19 at 2 21 14 PM

@stephentyrone stephentyrone deleted the document-augmented-arithmetic branch August 19, 2021 18:34
Comment on lines +43 to +44
/// - If `head` is normal, then `abs(tail) < abs(head.ulp)`.
/// Assuming IEEE 754 default rounding, `abs(tail) <= abs(head.ulp)/2`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are the “abs” on the right-hand sides necessary? I was under the impression that ulp was guaranteed to be non-negative for normal values. If so, the same thing applies to the doc comment for sum(large:small:).

Copy link
Member Author

@stephentyrone stephentyrone Aug 19, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's right (I'll roll this in with another upcoming PR)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants