Skip to content

docs: add Vlasov 1D docstring coverage#284

Merged
joglekara merged 2 commits into
mainfrom
docs/vlasov1d-docstrings
Jun 10, 2026
Merged

docs: add Vlasov 1D docstring coverage#284
joglekara merged 2 commits into
mainfrom
docs/vlasov1d-docstrings

Conversation

@joglekara

Copy link
Copy Markdown
Member

Summary

  • Add module, class, constructor, callable, and helper docstrings across the Vlasov 1D implementation package
  • Cover Pydantic config models, simulation/domain objects, storage callbacks, vector-field composition, and numerical pushers
  • Add a docstring to the public adept.vlasov1d entry point

Verification

  • uvx ruff format adept/_vlasov1d adept/vlasov1d.py
  • uvx ruff check adept/_vlasov1d adept/vlasov1d.py
  • AST docstring coverage scan over adept/_vlasov1d and adept/vlasov1d.py
  • uv run pytest tests/test_vlasov1d -q → 80 passed, 7 deselected, 1 xpassed

@joglekara joglekara merged commit 18c5714 into main Jun 10, 2026
8 checks passed
@joglekara joglekara deleted the docs/vlasov1d-docstrings branch June 10, 2026 19:40
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