Skip to content

fix docs #file -> #function #59

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Apr 17, 2019
Merged

fix docs #file -> #function #59

merged 2 commits into from
Apr 17, 2019

Conversation

grundoon
Copy link
Contributor

Multiple occurrences of #file in docs where #function was intended.

Motivation:

Parameter function is repeatedly documented as

///    - function: The function this log message originates from (there's usually no need to pass it explicitly as
///                it defaults to `#file`.

Modifications:

--> change all occurrences to "it defaults to #function."

Result:

(above)

@grundoon
fix docs #file -> #function
574282b 
Multiple occurrences of `#file` in docs where `#function` was intended.
@swift-server-bot
Copy link

Can one of the admins verify this patch?

1 similar comment
@swift-server-bot
Copy link

Can one of the admins verify this patch?

weissi
weissi approved these changes Apr 16, 2019
View reviewed changes
Copy link
Member

@weissi weissi left a comment

Choose a reason for hiding this comment

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

thank you very much!

@weissi
Copy link
Member

weissi commented Apr 16, 2019

@swift-server-bot test this please

@grundoon
Copy link
Contributor Author

@weissi Gah, just noticed all the file, function, line parameter docs should have closing parentheses. PR branch updated to account for these.

@weissi
Copy link
Member

weissi commented Apr 16, 2019

@swift-server-bot test this please

ktoso
ktoso approved these changes Apr 17, 2019
View reviewed changes
Copy link
Member

@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.

Thank you! 👍

@weissi weissi merged commit 250cef0 into apple:master Apr 17, 2019
@grundoon grundoon deleted the fix-docs-function-typos branch April 17, 2019 15:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ktoso ktoso ktoso approved these changes

@weissi weissi weissi approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@grundoon @swift-server-bot @weissi @ktoso