Skip to content
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

Add docstrings for SHA module #36777

Merged
merged 3 commits into from
Aug 8, 2020
Merged

Add docstrings for SHA module #36777

merged 3 commits into from
Aug 8, 2020

Conversation

chris-b1
Copy link
Contributor

progress towards #31202

dkarrasch
dkarrasch reviewed Jul 24, 2020
View reviewed changes
Copy link
Member

@dkarrasch dkarrasch left a comment

Choose a reason for hiding this comment

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

Welcome @chris-b1, and thanks for working on this. I'm not an expert on the matter, just saw some typos. Generally, I believe we consider phrases in docstrings as full sentences, so they should be closed by a period.

stdlib/SHA/src/SHA.jl Outdated Show resolved Hide resolved
stdlib/SHA/src/SHA.jl Outdated Show resolved Hide resolved
stdlib/SHA/src/SHA.jl Outdated Show resolved Hide resolved
stdlib/SHA/src/SHA.jl Outdated Show resolved Hide resolved
stdlib/SHA/src/SHA.jl Outdated Show resolved Hide resolved
@dkarrasch dkarrasch added the docs This change adds or pertains to documentation label Jul 24, 2020
@chris-b1
Copy link
Contributor Author

Thanks for the review @dkarrasch - fixed those sentences/typos

JeffBezanson
JeffBezanson reviewed Jul 26, 2020
View reviewed changes
stdlib/SHA/src/SHA.jl Outdated
The SHA module provides hashing functionality for SHA1, SHA2 and SHA3 algorithms.

They are implemented as both pure functions for hashing single pieces of data,
or a stateful context which can be updated with the `update!` function and
Copy link
Member

Choose a reason for hiding this comment

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

Trailing whitespace here.

@JeffBezanson JeffBezanson merged commit be7407f into JuliaLang:master Aug 8, 2020
simeonschaub pushed a commit to simeonschaub/julia that referenced this pull request Aug 11, 2020
@chris-b1 @simeonschaub
Add docstrings for SHA module (JuliaLang#36777)
24e0c5d
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dkarrasch dkarrasch dkarrasch left review comments

@JeffBezanson JeffBezanson JeffBezanson left review comments

Assignees
No one assigned
Labels
docs This change adds or pertains to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@chris-b1 @JeffBezanson @dkarrasch