Skip to content

Add documentation for initializers that build a node from a header and a result builder #1617

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 1 commit into from
May 2, 2023

Conversation

ahoppen
Copy link
Member

@ahoppen ahoppen commented Apr 28, 2023

rdar://108643660

@ahoppen ahoppen changed the title Add documentation for initializers that build a node from a header an Add documentation for initializers that build a node from a header and a result builder Apr 28, 2023
@ahoppen ahoppen requested a review from bnbarham April 28, 2023 20:24
@ahoppen
Copy link
Member Author

ahoppen commented Apr 28, 2023

@swift-ci Please test

@ahoppen
Copy link
Member Author

ahoppen commented Apr 29, 2023

@swift-ci Please test Windows

/// }
/// ```
///
/// You can use
Copy link
Contributor

Choose a reason for hiding this comment

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

I like how this one has an actual example of how to construct it. How would you feel about adding something similar to the others? If not that's fine, some documentation is better than none :). But a lot of the For example the following ... has ... could just be code instead.

Copy link
Member Author

Choose a reason for hiding this comment

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

Added more examples

@ahoppen ahoppen force-pushed the ahoppen/header-doc branch from 167605e to 72fa67c Compare May 1, 2023 21:53
@ahoppen
Copy link
Member Author

ahoppen commented May 1, 2023

@swift-ci Please test

1 similar comment
@ahoppen
Copy link
Member Author

ahoppen commented May 1, 2023

@swift-ci Please test

@ahoppen ahoppen merged commit af14609 into swiftlang:main May 2, 2023
@ahoppen ahoppen deleted the ahoppen/header-doc branch May 2, 2023 03:02
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