Update exdoc to add groups for modules and improve some docs

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.{

lib/code_corps_web/controllers/github_issue_controller.ex

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

lib/code_corps_web/controllers/github_pull_request_controller.ex

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

lib/code_corps_web/controllers/github_repo_controller.ex

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

lib/code_corps_web/controllers/organization_controller.ex

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

lib/code_corps_web/controllers/organization_github_app_installation_controller.ex

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

lib/code_corps_web/controllers/organization_invite_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.OrganizationInviteController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Emails, Helpers.Query, Mailer, OrganizationInvite, User}

lib/code_corps_web/controllers/page_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.PageController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   def index(conn, _params) do

lib/code_corps_web/controllers/password_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.PasswordController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Services.ForgotPasswordService}

lib/code_corps_web/controllers/password_reset_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.PasswordResetController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{User, AuthToken}

lib/code_corps_web/controllers/preview_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.PreviewController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Preview, User}

lib/code_corps_web/controllers/project_category_controller.ex

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

lib/code_corps_web/controllers/project_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.ProjectController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Project, User}

lib/code_corps_web/controllers/project_github_repo_controller.ex

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

lib/code_corps_web/controllers/project_skill_controller.ex

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

lib/code_corps_web/controllers/project_user_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.ProjectUserController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Emails, Helpers.Query, Mailer, ProjectUser, User}

lib/code_corps_web/controllers/role_controller.ex

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

lib/code_corps_web/controllers/role_skill_controller.ex

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

lib/code_corps_web/controllers/skill_controller.ex

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

lib/code_corps_web/controllers/slugged_route_controller.ex

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

lib/code_corps_web/controllers/stripe_connect_account_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripeConnectAccountController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.ConnUtils

lib/code_corps_web/controllers/stripe_connect_events_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripeConnectEventsController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.StripeService.WebhookProcessing.{

lib/code_corps_web/controllers/stripe_connect_plan_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripeConnectPlanController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{StripeConnectPlan, User}

lib/code_corps_web/controllers/stripe_connect_subscription_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripeConnectSubscriptionController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{StripeConnectSubscription, User}

lib/code_corps_web/controllers/stripe_platform_card_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripePlatformCardController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.StripeService.StripePlatformCardService

lib/code_corps_web/controllers/stripe_platform_customer_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripePlatformCustomerController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.StripeService.StripePlatformCustomerService

lib/code_corps_web/controllers/stripe_platform_events_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.StripePlatformEventsController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.StripeService.WebhookProcessing.{

lib/code_corps_web/controllers/task_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.TaskController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{Task, Policy, User}

lib/code_corps_web/controllers/task_list_controller.ex

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

lib/code_corps_web/controllers/task_skill_controller.ex

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

lib/code_corps_web/controllers/token_controller.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.TokenController do
+  @moduledoc false
   use CodeCorpsWeb, :controller
   import Comeonin.Bcrypt, only: [checkpw: 2, dummy_checkpw: 0]
   alias CodeCorpsWeb.GuardianSerializer

lib/code_corps_web/controllers/user_category_controller.ex

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

lib/code_corps_web/controllers/user_controller.ex

@@ -1,4 +1,76 @@
 defmodule CodeCorpsWeb.UserController do
+  @moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
+@moduledoc false
   use CodeCorpsWeb, :controller
 
   alias CodeCorps.{

lib/code_corps_web/controllers/user_role_controller.ex

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

lib/code_corps_web/controllers/user_skill_controller.ex

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

lib/code_corps_web/controllers/user_task_controller.ex

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

lib/code_corps_web/views/category_view.ex

@@ -1,4 +1,5 @@
 defmodule CodeCorpsWeb.CategoryView do
+  @moduledoc false
   use CodeCorpsWeb.PreloadHelpers, default_preloads: [:project_categories]
   use CodeCorpsWeb, :view
   use JaSerializer.PhoenixView