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.

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

Fix various spelling errors and details #43

Merged
merged 1 commit into from
Jan 27, 2020
Merged

Fix various spelling errors and details #43

merged 1 commit into from
Jan 27, 2020

Conversation

HeroicKatora
Copy link
Member

Various notables where I'm open to discussion, if necessary.

  • Promoted a few normal comments to doc comments. This was not done where the comment subjectively applied to multiple items.
  • Change unencoded data to arbitrary data in the stream documentation. I don't think the adjective use is very common and this avoids giving the impression that the input has to fulfill some invariants.

/// the deflate stream.
///
/// Returns a tuple containing a vec of the encoded lengths
Copy link
Member Author

@HeroicKatora HeroicKatora Jan 26, 2020

Choose a reason for hiding this comment

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

This is the one deleted line in the diff. Since the method has a unit return type, I suppose this comment was outdated.

Copy link
Collaborator

Choose a reason for hiding this comment

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

Indeed

@HeroicKatora HeroicKatora merged commit 2385f2a into dev Jan 27, 2020
@HeroicKatora HeroicKatora deleted the doc-spelling branch January 27, 2020 12:40
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