Skip to content

Add more documentation to yesod-test#1676

Merged
MaxGabriel merged 4 commits intomasterfrom
documentYesodTest
Jun 1, 2020
Merged

Add more documentation to yesod-test#1676
MaxGabriel merged 4 commits intomasterfrom
documentYesodTest

Conversation

@MaxGabriel
Copy link
Copy Markdown
Member

@MaxGabriel MaxGabriel commented May 31, 2020

This adds high-level documentation to yesod-test, plus some function documentation

Before submitting your PR, check that you've:

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)

MaxGabriel added 3 commits May 31, 2020 16:35
@MaxGabriel
Add more documentation to yesod-test
c3fa2ad 
This adds high-level documentation to yesod-test, plus some function documentation
@MaxGabriel
..
ab8a994
@MaxGabriel
..
8e89ec0
MaxGabriel
MaxGabriel commented May 31, 2020
View reviewed changes
MaxGabriel
MaxGabriel commented May 31, 2020
View reviewed changes
MaxGabriel
MaxGabriel commented May 31, 2020
View reviewed changes
yesod-test/Yesod/Test.hs
@
spec :: Spec
spec = withApp $ do
describe \"Homepage\" $ do
Copy link
Copy Markdown
Member Author

@MaxGabriel MaxGabriel May 31, 2020

Choose a reason for hiding this comment

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

Unfortunately escaping Haddock is a pain.

Here's a screenshot showing there aren't any Haddock escaping mistakes (I hope!):

image

MaxGabriel
MaxGabriel commented May 31, 2020
View reviewed changes
snoyberg
snoyberg approved these changes Jun 1, 2020
View reviewed changes
Copy link
Copy Markdown
Member

@snoyberg snoyberg left a comment

Choose a reason for hiding this comment

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

Really nice addition, thank you! I'd say merge when you're ready.

@MaxGabriel MaxGabriel merged commit b94da05 into master Jun 1, 2020
@MaxGabriel
Copy link
Copy Markdown
Member Author

MaxGabriel commented Jun 1, 2020

Thanks Michael! Merged, will release in a moment

@MaxGabriel
Copy link
Copy Markdown
Member Author

MaxGabriel commented Jun 1, 2020

Some followup: I noticed that this commit 804b114#diff-db7413bfa3e96b76f6cb9c8e4822433e bumped the dependency on base, but wasn't released as a new version. I added that to the changelog.

I tried to upload but got this error:

~/D/C/H/y/yesod> stack upload tarballs/*                                                                                                                  11:58:18
Checking package 'yesod-test' for common mistakes
Uploading yesod-test-1.6.9.1.tar.gz... unhandled status code: 400
Error: Invalid package

'cabal-version' must be at least 1.10
Control.Exception.Safe.throwString called with:

Upload failed on yesod-test-1.6.9.1.tar.gz
Called from:
  throwString (src/Stack/Upload.hs:192:17 in stack-2.3.1-uJmAnqRCkR1VKbFrmxCOZ:Stack.Upload)

Do I just bump the cabal-version in the .cabal file? I didn't see other reports of this when googling, so was sort of confused to see it

@snoyberg
Copy link
Copy Markdown
Member

snoyberg commented Jun 1, 2020

I think it's a new "feature" of Hackage, I had to do it to another package recently. Yes, just bump the cabal-version.

@MaxGabriel
Copy link
Copy Markdown
Member Author

MaxGabriel commented Jun 1, 2020 •
edited
Loading

Thanks, released 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@snoyberg snoyberg snoyberg approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@MaxGabriel @snoyberg