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

docs: fix EncMode example in the package comment #375

Merged
merged 1 commit into from
Nov 19, 2022
Merged

docs: fix EncMode example in the package comment #375

merged 1 commit into from
Nov 19, 2022

Conversation

creachadair
Copy link
Contributor

A few of the examples show calling the EncMode method with only one result (the mode) rather than a mode and an error.

Fixes #374.

N.B.: This PR is morally a documentation fix, although it does change a source file. I verified that all the tests still pass, but omitted the checklist on that basis. If you'd prefer to have it anyway, I'm happy to update the PR.

A few of the examples show calling the EncMode method with only one result (the
mode) rather than a mode and an error.

Fixes #374.

Signed-off-by: M. J. Fromberger <michael.j.fromberger@gmail.com>
@creachadair creachadair changed the title doc: fix EncMode example in the package comment docs: fix EncMode example in the package comment Nov 18, 2022
Copy link
Owner

@fxamacker fxamacker left a comment

Choose a reason for hiding this comment

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

LGTM! Thanks for the doc fix!

@fxamacker fxamacker merged commit 1c59246 into fxamacker:master Nov 19, 2022
@creachadair creachadair deleted the mjf/doc-example-fix branch November 19, 2022 18:26
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.

docs: typo in the EncMode example in the package comment
2 participants