Skip to content

Documentation fixes #60178

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
merged 9 commits into from
Aug 24, 2022
Merged

Documentation fixes #60178

merged 9 commits into from
Aug 24, 2022

Conversation

amartini51
Copy link
Member

Minor documentation style and correctness fixes

Resolves: rdar://97022479&77649895&86212313&79689446&93208475

The documentation publication pipeline doesn't have a way to expose
per-architecture availability, like how it it shows per-platform
availability.  So add this in prose instead.

Fixes <rdar://77649895>

/// A half-precision (16b), floating-point value type.
///
/// `Float16` is available on Apple silicon, and unavailable on Intel.'''
Copy link
Contributor

Choose a reason for hiding this comment

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

Need a "when targeting macOS" here; it is available on Intel/Linux and Windows.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed in 4d35aae.

/// An extended-precision, floating-point value type.'''
/// An extended-precision, floating-point value type.
///
/// `Float80` is available on Intel, and unavailable on Apple silicon.'''
Copy link
Contributor

Choose a reason for hiding this comment

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

This one is even more complex, it's probably best to say "Only available on Intel when the target system uses 80-bit long double" or similar.

Copy link
Member Author

Choose a reason for hiding this comment

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

Changed in 4d35aae.

@amartini51
Copy link
Member Author

@swift-ci Please smoke test.

Copy link
Contributor

@ktoso ktoso left a comment

Choose a reason for hiding this comment

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

Group changes LGTM, thanks!

@amartini51 amartini51 requested a review from bjlanier August 10, 2022 17:05
@amartini51 amartini51 merged commit 8556e83 into swiftlang:main Aug 24, 2022
@amartini51 amartini51 deleted the doc_fixes branch August 24, 2022 20:55
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.

5 participants