Merge pull request #1103 from code-corps/update-docs

Update exdoc to add groups for modules and improve some docs

Author: joshsmith

lib/code_corps/github/sync/pull_request/pull_request.ex

@@ -1,6 +1,5 @@
 defmodule CodeCorps.GitHub.Sync.PullRequest do
   alias CodeCorps.GitHub.Sync.PullRequest.GithubPullRequest, as: GithubPullRequestSyncer
-  alias CodeCorps.GitHub.Sync.User.RecordLinker, as: UserRecordLinker
   alias Ecto.Multi
 
   @doc ~S"""

lib/code_corps/github/sync/sync.ex

@@ -100,26 +100,19 @@ defmodule CodeCorps.GitHub.Sync do
     |> transact()
   end
 
-  @doc ~S"""
-  Finds the `CodeCorps.GithubRepo` using `GitHub.Sync.Utils.RepoFinder`.
-  """
+  @doc false
   def find_repo(_, payload) do
     Multi.new
     |> Multi.run(:repo, fn _ -> RepoFinder.find_repo(payload) end)
   end
 
-  @doc ~S"""
-  Fetches an issue from the GitHub API using `GitHub.API.Issue.from_url/2`.
-  """
+  @doc false
   def fetch_issue(%{repo: %GithubRepo{} = github_repo}, url) do
     Multi.new
     |> Multi.run(:fetch_issue, fn _ -> GitHub.API.Issue.from_url(url, github_repo) end)
   end
 
-  @doc ~S"""
-  Fetches a pull request from the GitHub API using
-  `GitHub.API.PullRequest.from_url/2`.
-  """
+  @doc false
   def fetch_pull_request(%{repo: %GithubRepo{} = github_repo}, url) do
     Multi.new
     |> Multi.run(:fetch_pull_request, fn _ -> GitHub.API.PullRequest.from_url(url, github_repo) end)

lib/code_corps/stripe_service/stripe_platform_customer.ex

@@ -33,7 +33,7 @@ defmodule CodeCorps.StripeService.StripePlatformCustomerService do
   end
 
   @doc """
-  Updates a `CodeCorps.StripePlatformCustomer` local and associated `%Stripe.Customer{} API record
+  Updates a `CodeCorps.StripePlatformCustomer` local and associated `%Stripe.Customer{}` API record
   with provided attributes
 
   Returns
@@ -55,15 +55,15 @@ defmodule CodeCorps.StripeService.StripePlatformCustomerService do
   end
 
   @doc """
-  Updates a `CodeCorps.StripePlatformCustomer` local record using `%Stripe.Customer{} API record
+  Updates a `CodeCorps.StripePlatformCustomer` local record using `%Stripe.Customer{}` API record
   retrieved from API using the provided Stripe ID
 
   Returns
 
   - `{:ok, %CodeCorps.StripePlatformCustomer{}}` if the local record was updated
   - `{:error, :not_found}` - If there was no record witht he specified Stripe ID
   - `{:error, %Ecto.Changeset{}}` -if there was a validation issue while updating the local record
-  - `{:error, %Stripe.APIErrorResposne{}}` - if there was a problem with retrieving the API record
+  - `{:error, %Stripe.APIErrorResponse{}}` - if there was a problem with retrieving the API record
   - `{:error, :unhandled}` -if something unexpected went wrong
   """
   def update_from_stripe(id_from_stripe) do

lib/code_corps/stripe_service/webhook_processing/ignored_event_handler.ex

@@ -45,7 +45,7 @@ defmodule CodeCorps.StripeService.WebhookProcessing.IgnoredEventHandler do
   Determines the reason for ignoring the event, then updates the record to
   `status: "ignored"` and `ignored_reason: inferred_message`
 
-  Returns `{:ok, %CodeCorps.StripeEvent{}}
+  Returns `{:ok, %CodeCorps.StripeEvent{}}`
   """
   @spec handle(StripeEvent.t, module) :: {:ok, StripeEvent.t}
   def handle(%StripeEvent{type: type} = local_event, handler) do

lib/code_corps_web/controllers/category_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.CategoryController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Category, User, Helpers.Query}

lib/code_corps_web/controllers/comment_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.CommentController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Comment, User, Helpers.Query}

lib/code_corps_web/controllers/donation_goal_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.DonationGoalController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.Services.DonationGoalsService

lib/code_corps_web/controllers/fallback_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.FallbackController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias Ecto.Changeset

lib/code_corps_web/controllers/github_app_installation_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.GithubAppInstallationController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   import CodeCorps.Helpers.Query, only: [id_filter: 2]

lib/code_corps_web/controllers/github_events_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.GitHubEventsController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.GitHub.Webhook.{