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 doc examples #357

Merged
merged 1 commit into from
Apr 12, 2019
Merged

Fix doc examples #357

merged 1 commit into from
Apr 12, 2019

Conversation

jhrcek
Copy link
Contributor

@jhrcek jhrcek commented Apr 5, 2019

@phadej I'm absolutely delighted by this package. It's so well documented and easy to use. You're doing great work for Haskell community. Thank you!
This PR fixes most documentation examples that didn't work with the current version of the package.

@jhrcek jhrcek changed the title Fix initial cabal example Fix doc examples Apr 7, 2019
src/GitHub.hs Outdated
@@ -7,7 +7,7 @@
-- this package.
--
-- See "GitHub.Request" module for executing 'Request', or other modules
-- of this package (e.g. "GitHub.Users") for already composed versions.
-- of this package (e.g. "GitHub.Data.Users") for already composed versions.
Copy link
Contributor

Choose a reason for hiding this comment

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

this is incorrect. (some) "composed" requests are in Endpoints modules, in this case e.g. http://hackage.haskell.org/package/github-0.21/docs/GitHub-Endpoints-Users.html

Copy link
Contributor Author

Choose a reason for hiding this comment

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

My mistake. Fixed.

@jhrcek
Copy link
Contributor Author

jhrcek commented Apr 10, 2019

@phadej I think it's ready to merge

@phadej phadej merged commit 9fa0b01 into haskell-github:master Apr 12, 2019
@phadej
Copy link
Contributor

phadej commented Apr 12, 2019

Thanks!

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