Skip to content

Fix module docstrings across emulsim package - #111

Merged
david-zwicker merged 1 commit into
masterfrom
copilot/check-module-descriptions
Jun 16, 2026
Merged

david-zwicker merged 1 commit into
masterfrom
copilot/check-module-descriptions

Conversation

Copilot AI commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Several Python modules in the emulsim package had missing, inaccurate, or incomplete module-level docstrings and .. autosummary:: listings.

Changes

  • Missing descriptions — added accurate one-line module descriptions and .. autosummary:: blocks to actors/autonomous/active_particles.py, box.py, brownian_motion.py, and coalescence.py (previously only had .. codeauthor::)
  • Grammar fix — actors/autonomous/emitters.py: "that emit … a predefined positions" → "that emits … at predefined positions"; also added missing autosummary
  • Incomplete autosummaries — added missing public symbols:
    • actors/base.py: added ~ActorBase and ~find_actors
    • actors/coupling/fields.py: added ~FieldCouplingActor, ~FieldExchangeActor, ~FieldBoundaryExchangeActor
    • actors/coupling/spherical_droplet.py: added ~PointsOnSphere
    • elements/base.py: added DictElementBase
  • Inaccurate description — elements/multicomponent_droplets.py said "spherical droplets"; corrected to "multicomponent droplets"; added autosummary
  • No autosummary at all — added .. autosummary:: blocks to elements/points.py, elements/spherical_droplets.py, and state.py

@david-zwicker
david-zwicker marked this pull request as ready for review June 16, 2026 14:37
@david-zwicker
david-zwicker merged commit 931399f into master Jun 16, 2026
6 checks passed
@david-zwicker
david-zwicker deleted the copilot/check-module-descriptions branch June 16, 2026 14:44
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.

2 participants