Merge pull request #357 from jhrcek/fixExample

Fix doc examples

Author: phadej

github.cabal

@@ -15,7 +15,7 @@ description:
   >
   > main :: IO ()
   > main = do
-  >     possibleUser <- GH.executeRequest' $ GH.userInfoR "phadej"
+  >     possibleUser <- GH.executeRequest' $ GH.userInfoForR "phadej"
   >     print possibleUser
   .
   For more of an overview please see the README: <https://github.com/phadej/github/blob/master/README.md>

src/GitHub.hs

@@ -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.Endpoints.Users") for already composed versions.
 --
 -- The missing endpoints lists show which endpoints we know are missing, there
 -- might be more.

src/GitHub/Data.hs

@@ -4,7 +4,7 @@
 -- License     :  BSD-3-Clause
 -- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
 --
--- This module re-exports the @GitHub.Data.@ and "Github.Auth" submodules.
+-- This module re-exports the @GitHub.Data.@ and "GitHub.Auth" submodules.
 module GitHub.Data (
     -- * Tagged types
     -- ** Name

src/GitHub/Endpoints/Activity/Watching.hs

@@ -30,7 +30,7 @@ watchersFor = watchersFor' Nothing
 -- | The list of users that are watching the specified Github repo.
 -- With authentication
 --
--- > watchersFor' (Just (User (user, password))) "thoughtbot" "paperclip"
+-- > watchersFor' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip"
 watchersFor' :: Maybe Auth -> Name Owner -> Name Repo -> IO (Either Error (Vector SimpleUser))
 watchersFor' auth user repo =
     executeRequestMaybe auth $ watchersForR user repo FetchAll
@@ -50,7 +50,7 @@ reposWatchedBy = reposWatchedBy' Nothing
 -- | All the public repos watched by the specified user.
 -- With authentication
 --
--- > reposWatchedBy' (Just (User (user, password))) "croaky"
+-- > reposWatchedBy' (Just $ BasicAuth "github-username" "github-password") "croaky"
 reposWatchedBy' :: Maybe Auth -> Name Owner -> IO (Either Error (Vector Repo))
 reposWatchedBy' auth user =
     executeRequestMaybe auth $ reposWatchedByR user FetchAll

src/GitHub/Endpoints/Gists.hs

@@ -27,7 +27,7 @@ import Prelude ()
 
 -- | The list of all gists created by the user
 --
--- > gists' (Just ("github-username", "github-password")) "mike-burns"
+-- > gists' (Just $ BasicAuth "github-username" "github-password") "mike-burns"
 gists' :: Maybe Auth -> Name Owner -> IO (Either Error (Vector Gist))
 gists' auth user =
     executeRequestMaybe auth $ gistsR user FetchAll
@@ -45,7 +45,7 @@ gistsR user = pagedQuery ["users", toPathPart user, "gists"] []
 
 -- | A specific gist, given its id, with authentication credentials
 --
--- > gist' (Just ("github-username", "github-password")) "225074"
+-- > gist' (Just $ BasicAuth "github-username" "github-password") "225074"
 gist' :: Maybe Auth -> Name Gist -> IO (Either Error Gist)
 gist' auth gid =
     executeRequestMaybe auth $ gistR gid
@@ -64,7 +64,7 @@ gistR gid =
 
 -- | Star a gist by the authenticated user.
 --
--- > starGist ("github-username", "github-password") "225074"
+-- > starGist (BasicAuth "github-username" "github-password") "225074"
 starGist :: Auth -> Name Gist -> IO (Either Error ())
 starGist auth gid = executeRequest auth $ starGistR gid
 
@@ -75,7 +75,7 @@ starGistR gid = Command Put ["gists", toPathPart gid, "star"] mempty
 
 -- | Unstar a gist by the authenticated user.
 --
--- > unstarGist ("github-username", "github-password") "225074"
+-- > unstarGist (BasicAuth "github-username" "github-password") "225074"
 unstarGist :: Auth -> Name Gist -> IO (Either Error ())
 unstarGist auth gid = executeRequest auth $ unstarGistR gid
 
@@ -86,7 +86,7 @@ unstarGistR gid = command Delete ["gists", toPathPart gid, "star"] mempty
 
 -- | Delete a gist by the authenticated user.
 --
--- > deleteGist ("github-username", "github-password") "225074"
+-- > deleteGist (BasicAuth "github-username" "github-password") "225074"
 deleteGist :: Auth -> Name Gist -> IO (Either Error ())
 deleteGist auth gid = executeRequest auth $ deleteGistR gid
 

src/GitHub/Endpoints/GitData/Blobs.hs

@@ -19,7 +19,7 @@ import Prelude ()
 
 -- | Query a blob by SHA1.
 --
--- > blob' (Just ("github-username", "github-password")) "thoughtbot" "paperclip" "bc5c51d1ece1ee45f94b056a0f5a1674d7e8cba9"
+-- > blob' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" "bc5c51d1ece1ee45f94b056a0f5a1674d7e8cba9"
 blob' :: Maybe Auth -> Name Owner -> Name Repo -> Name Blob -> IO (Either Error Blob)
 blob' auth user repo sha =
     executeRequestMaybe auth $ blobR user repo sha

src/GitHub/Endpoints/GitData/References.hs

@@ -26,7 +26,7 @@ import Prelude ()
 
 -- | A single reference by the ref name.
 --
--- > reference' (Just ("github-username", "github-password")) "mike-burns" "github" "heads/master"
+-- > reference' (Just $ BasicAuth "github-username" "github-password") "mike-burns" "github" "heads/master"
 reference' :: Maybe Auth -> Name Owner -> Name Repo -> Name GitReference -> IO (Either Error GitReference)
 reference' auth user repo ref =
     executeRequestMaybe auth $ referenceR user repo ref

src/GitHub/Endpoints/GitData/Trees.hs

@@ -22,7 +22,7 @@ import Prelude ()
 
 -- | A tree for a SHA1.
 --
--- > tree (Just ("github-username", "github-password")) "thoughtbot" "paperclip" "fe114451f7d066d367a1646ca7ac10e689b46844"
+-- > tree (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" "fe114451f7d066d367a1646ca7ac10e689b46844"
 tree' :: Maybe Auth -> Name Owner -> Name Repo -> Name Tree -> IO (Either Error Tree)
 tree' auth user repo sha =
     executeRequestMaybe auth $ treeR user repo sha
@@ -41,7 +41,7 @@ treeR user repo sha =
 
 -- | A recursively-nested tree for a SHA1.
 --
--- > nestedTree' (Just ("github-username", "github-password")) "thoughtbot" "paperclip" "fe114451f7d066d367a1646ca7ac10e689b46844"
+-- > nestedTree' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" "fe114451f7d066d367a1646ca7ac10e689b46844"
 nestedTree' :: Maybe Auth -> Name Owner -> Name Repo -> Name Tree -> IO (Either Error Tree)
 nestedTree' auth user repo sha =
     executeRequestMaybe auth $ nestedTreeR user repo sha

src/GitHub/Endpoints/Issues.hs

@@ -41,7 +41,7 @@ organizationIssuesR org opts =
 -- | Details on a specific issue, given the repo owner and name, and the issue
 -- number.'
 --
--- > issue' (Just ("github-username", "github-password")) "thoughtbot" "paperclip" "462"
+-- > issue' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" "462"
 issue' :: Maybe Auth -> Name Owner -> Name Repo -> Id Issue -> IO (Either Error Issue)
 issue' auth user reqRepoName reqIssueNumber =
     executeRequestMaybe auth $ issueR user reqRepoName reqIssueNumber
@@ -62,7 +62,7 @@ issueR user reqRepoName reqIssueNumber =
 -- | All issues for a repo (given the repo owner and name), with optional
 -- restrictions as described in the 'IssueRepoMod' data type.
 --
--- > issuesForRepo' (Just ("github-username", "github-password")) "thoughtbot" "paperclip" [NoMilestone, OnlyClosed, Mentions "jyurek", Ascending]
+-- > issuesForRepo' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" [NoMilestone, OnlyClosed, Mentions "jyurek", Ascending]
 issuesForRepo' :: Maybe Auth -> Name Owner -> Name Repo -> IssueRepoMod -> IO (Either Error (Vector Issue))
 issuesForRepo' auth user reqRepoName opts =
     executeRequestMaybe auth $ issuesForRepoR user reqRepoName opts FetchAll
@@ -90,7 +90,7 @@ newIssue title = NewIssue title Nothing mempty Nothing Nothing
 
 -- | Create a new issue.
 --
--- > createIssue (User (user, password)) user repo
+-- > createIssue (BasicAuth "github-username" "github-password") user repo
 -- >  (newIssue "some_repo") {...}
 createIssue :: Auth -> Name Owner -> Name Repo -> NewIssue
             -> IO (Either Error Issue)
@@ -110,7 +110,7 @@ editOfIssue = EditIssue Nothing Nothing Nothing Nothing Nothing Nothing
 
 -- | Edit an issue.
 --
--- > editIssue (User (user, password)) user repo issue
+-- > editIssue (BasicAuth "github-username" "github-password") user repo issue
 -- >  editOfIssue {...}
 editIssue :: Auth -> Name Owner -> Name Repo -> Id Issue -> EditIssue
             -> IO (Either Error Issue)

src/GitHub/Endpoints/Issues/Comments.hs

@@ -46,7 +46,7 @@ comments = comments' Nothing
 
 -- | All comments on an issue, by the issue's number, using authentication.
 --
--- > comments' (User (user, password)) "thoughtbot" "paperclip" 635
+-- > comments' (Just $ BasicAuth "github-username" "github-password") "thoughtbot" "paperclip" 635
 comments' :: Maybe Auth -> Name Owner -> Name Repo -> IssueNumber -> IO (Either Error (Vector IssueComment))
 comments' auth user repo iid =
     executeRequestMaybe auth $ commentsR user repo iid FetchAll
@@ -59,7 +59,7 @@ commentsR user repo iid =
 
 -- | Create a new comment.
 --
--- > createComment (User (user, password)) user repo issue
+-- > createComment (BasicAuth "github-username" "github-password") user repo issue
 -- >  "some words"
 createComment :: Auth -> Name Owner -> Name Repo -> IssueNumber -> Text
             -> IO (Either Error Comment)
@@ -76,7 +76,7 @@ createCommentR user repo iss body =
 
 -- | Edit a comment.
 --
--- > editComment (User (user, password)) user repo commentid
+-- > editComment (BasicAuth "github-username" "github-password") user repo commentid
 -- >  "new words"
 editComment :: Auth -> Name Owner -> Name Repo -> Id Comment -> Text
             -> IO (Either Error Comment)
@@ -93,7 +93,7 @@ editCommentR user repo commid body =
 
 -- | Delete a comment.
 --
--- > deleteComment (User (user, password)) user repo commentid
+-- > deleteComment (BasicAuth "github-username" "github-password") user repo commentid
 deleteComment :: Auth -> Name Owner -> Name Repo -> Id Comment
               -> IO (Either Error ())
 deleteComment auth user repo commid =