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

Update haddock on assertEq to specify the expected and actual value ordering #1834

Merged
merged 1 commit into from
Mar 29, 2024

Conversation

jkeuhlen
Copy link
Contributor

Before submitting your PR, check that you've:

  • Bumped the version number
    (Documentation updates don't need a version number bump)
  • Documented new APIs with Haddock markup
    (Just improving documentation to match the docs for the underlying HUnit implementation.)
  • Added @since declarations to the Haddocks for new, public APIs
    N/A

After submitting your PR:

  • Update the Changelog.md file with a link to your PR
  • Check that CI passes (or if it fails, for reasons unrelated to your change, like CI timeouts)

@jkeuhlen
Copy link
Contributor Author

I'm unsure if this warrants a changelog update or not, but the impetus here is probably ~half of the tests in our codebase have this ordering backwards since most people just look at the yesod docs instead of the HUnit docs, so this makes them line up better!

@jezen
Copy link
Member

jezen commented Mar 29, 2024

Better documentation is always welcome. Thank you 👍

@jezen jezen merged commit 24457b7 into yesodweb:master Mar 29, 2024
10 of 14 checks passed
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.

None yet

2 participants