Skip to content

Clean up documentation drift#55

Merged
wilsonfreitas merged 1 commit into
project-health-hardeningfrom
hardening/36-clean-up-documentation-drift
Jun 14, 2026
Merged

Clean up documentation drift#55
wilsonfreitas merged 1 commit into
project-health-hardeningfrom
hardening/36-clean-up-documentation-drift

Conversation

@wilsonfreitas

Copy link
Copy Markdown
Owner

Summary

  • align README, Sphinx docs, examples, and public docstrings with current async, date-input, regional-mode, and TaxaJuros behavior
  • document local docs build command and docs dependency group
  • update async examples to close the shared async client and show current multi-symbol currency support
  • clean minor stale wording and example lint drift

Fixes #36

Verification

  • uv run pytest -m "not integration" (185 passed, 11 deselected)
  • uv run ruff check bcb/ tests/
  • uv run ruff format --check bcb/ tests/
  • uv run mypy bcb/
  • uv run --group docs sphinx-build -b html docs docs/_build/html
  • uv run ruff check bcb/ tests/ examples/async_usage.py examples/currency_exchange.py examples/odata_query.py examples/sgs_time_series.py
  • uv run ruff format --check bcb/ tests/ examples/async_usage.py examples/currency_exchange.py examples/odata_query.py examples/sgs_time_series.py

@wilsonfreitas
wilsonfreitas merged commit 2a6cc9e into project-health-hardening Jun 14, 2026
9 checks passed
@wilsonfreitas
wilsonfreitas deleted the hardening/36-clean-up-documentation-drift branch June 14, 2026 21:12
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant