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

mock: fix FunctionalOptions docs #1433

Merged
merged 2 commits into from Mar 22, 2024
Merged

mock: fix FunctionalOptions docs #1433

merged 2 commits into from Mar 22, 2024

Conversation

snirye
Copy link
Contributor

@snirye snirye commented Jul 23, 2023

Summary

the comment about this function is not updated with the final implementation

Changes

just the comment above the func

Motivation

its misleading

Related issues

some relevant links to the PR that added FunctionalOptions
#1023
suggestion 1
suggestion 2

mock/mock.go Outdated Show resolved Hide resolved
mock/mock.go Outdated Show resolved Hide resolved
mock/mock.go Outdated Show resolved Hide resolved
@snirye snirye requested a review from dolmen July 26, 2023 06:50
mock/mock.go Outdated
// FunctionalOptions returns an FunctionalOptionsArgument object containing the functional option type
// and the values to check of
// FunctionalOptions returns an FunctionalOptionsArgument object containing
// the expected functional-options to check for
Copy link
Collaborator

Choose a reason for hiding this comment

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

Missing dot at the end of the sentence.

Also, add godoc link.

@dolmen
Copy link
Collaborator

dolmen commented Jul 29, 2023

Please squash commits and be more careful about the commit message.

@snirye
Copy link
Contributor Author

snirye commented Sep 3, 2023

Hi @dolmen , can you please review again?

Copy link
Collaborator

@dolmen dolmen left a comment

Choose a reason for hiding this comment

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

Please fix the commit message: "remove old input args" is not helpful in the project history.

Use instead: "assert.FunctionalOptions: fix go doc"

@dolmen dolmen changed the title remove old input args from FunctionalOptions docs assert: fix FunctionalOptions docs Oct 16, 2023
@snirye snirye force-pushed the master branch 2 times, most recently from 05c6a3b to 4ac55f1 Compare March 6, 2024 08:28
@dolmen dolmen changed the title assert: fix FunctionalOptions docs mock: fix FunctionalOptions docs Mar 22, 2024
@dolmen dolmen added pkg-mock Any issues related to Mock and removed pkg-assert Change related to package testify/assert labels Mar 22, 2024
@dolmen dolmen merged commit edd74b2 into stretchr:master Mar 22, 2024
7 checks passed
@dolmen dolmen added the mock.ArgumentMatcher About matching arguments in mock label Mar 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug documentation mock.ArgumentMatcher About matching arguments in mock pkg-mock Any issues related to Mock
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants