Skip to content

Add bound_first_names to the config defaults automodule list#234

Merged
derek73 merged 1 commit into
masterfrom
fix/docs-bound-first-names-automodule
Jul 5, 2026
Merged

Add bound_first_names to the config defaults automodule list#234
derek73 merged 1 commit into
masterfrom
fix/docs-bound-first-names-automodule

Conversation

@derek73

@derek73 derek73 commented Jul 5, 2026

Copy link
Copy Markdown
Owner

docs/modules.rst has automodule entries for six of the seven config modules; nameparser.config.bound_first_names (added in v1.3.0) was missing, so Sphinx references like ~bound_first_names.BOUND_FIRST_NAMES in the Constants class docstring had no target.

One-line fix: add the missing entry, placed after prefixes to match the module ordering used in AGENTS.md.

Verification

  • uv run sphinx-build -b html docs ...: build succeeded, no warnings
  • Nitpicky build (-n): unresolved BOUND_FIRST_NAMES references go from 2 on master to 0 on this branch
  • The one remaining bound_first_names-adjacent nitpicky warning (Constants.bound_first_names) is the pre-existing annotation-only-attribute pattern shared by Constants.regexes etc., unrelated to this fix

🤖 Generated with Claude Code

docs/modules.rst documents every config module except
bound_first_names (added in v1.3.0), so Sphinx references to
~bound_first_names.BOUND_FIRST_NAMES -- e.g. in the Constants class
docstring -- had no target and failed to resolve in nitpicky (-n)
builds. With the entry added, the two unresolved BOUND_FIRST_NAMES
references drop to zero and the default build stays warning-free.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@derek73 derek73 self-assigned this Jul 5, 2026
@derek73 derek73 added the docs Documentation fixes and updates label Jul 5, 2026
@derek73 derek73 added this to the v1.3.0 milestone Jul 5, 2026
@codecov-commenter

Copy link
Copy Markdown

⚠️ Please install the 'codecov app svg image' to ensure uploads and comments are reliably processed by Codecov.

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.29%. Comparing base (adbb772) to head (7d775cf).
❗ Your organization needs to install the Codecov GitHub app to enable full functionality.

Additional details and impacted files
@@           Coverage Diff           @@
##           master     #234   +/-   ##
=======================================
  Coverage   97.29%   97.29%           
=======================================
  Files          13       13           
  Lines         813      813           
=======================================
  Hits          791      791           
  Misses         22       22           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@derek73 derek73 merged commit 547e113 into master Jul 5, 2026
8 checks passed
@derek73 derek73 deleted the fix/docs-bound-first-names-automodule branch July 5, 2026 22:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Documentation fixes and updates

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants