show-users-2

phadej · phadej · commit 449ee122b784 · 2016-01-20T08:35:24.000+02:00
diff --git a/Github/All.hs b/Github/All.hs
@@ -3,10 +3,14 @@
 -- License     :  BSD-3-Clause
 -- Maintainer  :  Oleg Grenrus <oleg.grenrus@iki.fi>
 --
--- This module re-exports all request constructrors and
--- data definitions from this package.
+-- This module re-exports all request constructrors and data definitions from
+-- this package.
 --
--- The missing endpoints lists are exhausive, they indicate endpoints we know are missing.
+-- See 'Github.Request' module for executing 'GithubRequest', or other modules
+-- of this package (e.g. 'Github.Users') for already composed versions.
+--
+-- The missing endpoints lists show which endpoints we know are missing, there
+-- might be more.
 module Github.All (
     -- * Activity
     -- | See <https://developer.github.com/v3/activity/>
diff --git a/github.cabal b/github.cabal
@@ -1,12 +1,25 @@
 Name:                github
 Version:             0.14.0
 Synopsis:            Access to the Github API, v3.
-Description:         The Github API provides programmatic access to the full
-                     Github Web site, from Issues to Gists to repos down to the underlying git data
-                     like references and trees. This library wraps all of that, exposing a basic but
-                     Haskell-friendly set of functions and data structures.
-                     .
-                     For more of an overview please see the README: <https://github.com/phadej/github/blob/master/README.md>
+Description:
+  The Github API provides programmatic access to the full
+  Github Web site, from Issues to Gists to repos down to the underlying git data
+  like references and trees. This library wraps all of that, exposing a basic but
+  Haskell-friendly set of functions and data structures.
+  .
+  For supported endpoints see "Github.All" module.
+  .
+  >{-# LANGUAGE OverloadedStrings #-}
+  >module Main (main) where
+  >
+  >import qualified Github.All as GH
+  >
+  >main :: IO ()
+  >main = do
+  >    possibleUser <- GH.executeRequest' $ GH.userInfoR "phadej"
+  >    print possibleUser
+  .
+  For more of an overview please see the README: <https://github.com/phadej/github/blob/master/README.md>
 License:             BSD3
 License-file:        LICENSE
 Author:              Mike Burns, John Wiegley, Oleg Grenrus
diff --git a/samples/Users/ShowUser2.hs b/samples/Users/ShowUser2.hs
@@ -0,0 +1,9 @@
+{-# LANGUAGE OverloadedStrings #-}
+module Main (main) where
+
+import qualified Github.All as GH
+
+main :: IO ()
+main = do
+    possibleUser <- GH.executeRequest' $ GH.userInfoForR "phadej"
+    print possibleUser
diff --git a/samples/github-samples.cabal b/samples/github-samples.cabal
@@ -86,6 +86,7 @@ executable github-show-user
   other-modules:
       Followers.ListFollowers
       Followers.ListFollowing
+      ShowUser2
   default-language: Haskell2010
 
 executable github-list-following
@@ -192,6 +193,23 @@ executable github-delete-team
       TeamInfoFor
   default-language: Haskell2010
 
+executable github-show-user-2
+  main-is: ShowUser2.hs
+  hs-source-dirs:
+      Users
+  ghc-options: -Wall
+  build-depends:
+      base
+    , base-compat
+    , github
+    , text
+    , github-samples
+  other-modules:
+      Followers.ListFollowers
+      Followers.ListFollowing
+      ShowUser
+  default-language: Haskell2010
+
 executable github-teaminfo-for
   main-is: TeamInfoFor.hs
   hs-source-dirs:
diff --git a/samples/package.yaml b/samples/package.yaml
@@ -17,6 +17,11 @@ executables:
     source-dirs: Users
     dependencies:
       - github-samples
+  github-show-user-2:
+    main: ShowUser2.hs
+    source-dirs: Users
+    dependencies:
+      - github-samples
   github-list-followers:
     main: ListFollowers.hs
     source-dirs: Users/Followers
diff --git a/travis-script.sh b/travis-script.sh
@@ -6,7 +6,7 @@ case $BUILD in
     stack --no-terminal build github-samples
 
     # TODO: get executables from info
-    for testbin in show-user list-followers list-following; do
+    for testbin in show-user list-followers list-following operational; do
         echo "Running " $testbin
         stack exec github-$testbin
     done
