From 6c75a8b8bcacc48a4b485cb1ca1b484d4308433f Mon Sep 17 00:00:00 2001
From: Victor Lin <13424970+victorlin@users.noreply.github.com>
Date: Wed, 10 Jul 2024 14:06:38 -0700
Subject: [PATCH] Update wording around regenerating developer API docs

The old wording said "automatic" which is not entirely accurate since
you still have to manually commit and push the changes.
---
 .github/workflows/ci.yaml                                 | 2 +-
 ...e-developer-api-docs => regenerate-developer-api-docs} | 0
 docs/contribute/DEV_DOCS.md                               | 8 ++++----
 3 files changed, 5 insertions(+), 5 deletions(-)
 rename devel/{generate-developer-api-docs => regenerate-developer-api-docs} (100%)

diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml
index 2f6c89e5a..82ea46e28 100644
--- a/.github/workflows/ci.yaml
+++ b/.github/workflows/ci.yaml
@@ -219,7 +219,7 @@ jobs:
 
       - run: pip install .[dev]
 
-      - run: ./devel/generate-developer-api-docs
+      - run: ./devel/regenerate-developer-api-docs
 
       - name: Check for changes
         run: |
diff --git a/devel/generate-developer-api-docs b/devel/regenerate-developer-api-docs
similarity index 100%
rename from devel/generate-developer-api-docs
rename to devel/regenerate-developer-api-docs
diff --git a/docs/contribute/DEV_DOCS.md b/docs/contribute/DEV_DOCS.md
index a76ecf2fc..dd9f5750b 100644
--- a/docs/contribute/DEV_DOCS.md
+++ b/docs/contribute/DEV_DOCS.md
@@ -324,13 +324,13 @@ file in order to render the pages.
   reStructuredText file should be added under `docs/usage/cli/` in addition to
   the new file under `docs/api/`.
 
-### Automatically updating developer API docs
+### Regenerating developer API docs
 
-To update the developer API documentation after adding or removing an augur submodule,
-autogenerate a new API file as follows.
+To regenerate the developer API documentation after adding, renaming, or removing an augur
+submodule, autogenerate a new API file as follows.
 
 ```bash
-./devel/generate-developer-api-docs
+./devel/regenerate-developer-api-docs
 ```
 
 ### Building documentation