chore(docs): formatting cleanup for mkdocs-click

Author: thekaveman

compiler_admin/commands/info.py

@@ -6,9 +6,7 @@
 
 @click.command()
 def info():
-    """
-    Print information about the configured environment.
-    """
+    """Print information about the configured environment."""
     click.echo(f"compiler-admin, version {version}")
 
     CallGAMCommand(("version",))

compiler_admin/commands/init.py

@@ -30,8 +30,8 @@ def init(username: str, init_gam: bool = False, init_gyb: bool = False):
 
     See:
 
-    - [https://github.com/GAM-team/GAM/wiki/How-to-Install-GAM7](https://github.com/GAM-team/GAM/wiki/How-to-Install-GAM7)
-    - [https://github.com/GAM-team/got-your-back/wiki](https://github.com/GAM-team/got-your-back/wiki)
+    - <https://github.com/GAM-team/GAM/wiki/How-to-Install-GAM7>
+    - <https://github.com/GAM-team/got-your-back/wiki>
     """
     if init_gam:
         _clean_config_dir(GAM_CONFIG_PATH)

compiler_admin/commands/time/__init__.py

@@ -8,9 +8,7 @@
 
 @click.group
 def time():
-    """
-    Work with Compiler time entries.
-    """
+    """Work with Compiler time entries."""
     pass
 
 

compiler_admin/commands/user/__init__.py

@@ -6,17 +6,15 @@
 from compiler_admin.commands.user.deactivate import deactivate
 from compiler_admin.commands.user.delete import delete
 from compiler_admin.commands.user.offboard import offboard
-from compiler_admin.commands.user.reset import reset
 from compiler_admin.commands.user.reactivate import reactivate
+from compiler_admin.commands.user.reset import reset
 from compiler_admin.commands.user.restore import restore
 from compiler_admin.commands.user.signout import signout
 
 
 @click.group
 def user():
-    """
-    Work with users in the Compiler org.
-    """
+    """Work with users in the Compiler org."""
     pass
 
 

compiler_admin/commands/user/backupcodes.py

@@ -1,19 +1,13 @@
 import click
 
 from compiler_admin import RESULT_FAILURE
-from compiler_admin.services.google import (
-    get_backup_codes,
-    user_account_name,
-    user_exists,
-)
+from compiler_admin.services.google import get_backup_codes, user_account_name, user_exists
 
 
 @click.command()
 @click.argument("username")
 def backupcodes(username: str, **kwargs):
-    """
-    Get backup codes for the user, creating a new set if needed.
-    """
+    """Get backup codes for the user, creating a new set if needed."""
     account = user_account_name(username)
 
     if not user_exists(account):

compiler_admin/commands/user/convert.py

@@ -16,7 +16,6 @@
     user_is_staff,
 )
 
-
 ACCOUNT_TYPE_OU = {"contractor": OU_CONTRACTORS, "partner": OU_PARTNERS, "staff": OU_STAFF}
 
 
@@ -26,9 +25,7 @@
 @click.argument("account_type", type=click.Choice(ACCOUNT_TYPE_OU.keys(), case_sensitive=False))
 @click.pass_context
 def convert(ctx: click.Context, username: str, account_type: str, **kwargs):
-    """
-    Convert a user of one type to another.
-    """
+    """Convert a user of one type to another."""
     account = user_account_name(username)
 
     if not user_exists(account):

compiler_admin/commands/user/create.py

@@ -4,8 +4,8 @@
 from compiler_admin.services.google import (
     GROUP_TEAM,
     USER_HELLO,
-    add_user_to_group,
     CallGAMCommand,
+    add_user_to_group,
     user_account_name,
     user_exists,
 )
@@ -22,7 +22,7 @@ def create(username: str, notify: str = "", gam_args: list = []):
 
     Extra args are passed along to GAM as options.
 
-    https://github.com/GAM-team/GAM/wiki/Users#create-a-user
+    <https://github.com/GAM-team/GAM/wiki/Users#create-a-user>
     """
     account = user_account_name(username)
 

compiler_admin/commands/user/deactivate.py

@@ -32,9 +32,7 @@
 def deactivate(
     ctx: click.Context, username: str, force: bool = False, recovery_email: str = "", recovery_phone: str = "", **kwargs
 ):
-    """
-    Deactivate (but do not delete) a user.
-    """
+    """Deactivate (but do not delete) a user."""
     account = user_account_name(username)
 
     if not user_exists(account):

compiler_admin/commands/user/delete.py

@@ -8,9 +8,7 @@
 @click.option("-f", "--force", is_flag=True, help="Don't ask for confirmation.")
 @click.argument("username")
 def delete(username: str, force: bool = False, **kwargs):
-    """
-    Delete a user account.
-    """
+    """Delete a user account."""
     account = user_account_name(username)
 
     if not user_exists(account):

compiler_admin/commands/user/offboard.py

@@ -5,13 +5,7 @@
 from compiler_admin import RESULT_FAILURE, RESULT_SUCCESS
 from compiler_admin.commands.user.deactivate import deactivate
 from compiler_admin.commands.user.delete import delete
-from compiler_admin.services.google import (
-    USER_ARCHIVE,
-    CallGAMCommand,
-    CallGYBCommand,
-    user_account_name,
-    user_exists,
-)
+from compiler_admin.services.google import USER_ARCHIVE, CallGAMCommand, CallGYBCommand, user_account_name, user_exists
 
 
 @click.command()
@@ -22,8 +16,7 @@
 @click.argument("username")
 @click.pass_context
 def offboard(ctx: click.Context, username: str, alias: str = "", _delete: bool = False, force: bool = False, **kwargs):
-    """
-    Fully offboard a user from Compiler.
+    """Fully offboard a user from Compiler.
 
     Deactivate, back up email, transfer Calendar/Drive, and optionally delete.
     """