Skip to content

docs: add module docstring and improve class docstrings in cosmology package#294

Merged
Jammy2211 merged 1 commit intomainfrom
docs/cosmology
Mar 12, 2026
Merged

docs: add module docstring and improve class docstrings in cosmology package#294
Jammy2211 merged 1 commit intomainfrom
docs/cosmology

Conversation

@Jammy2211
Copy link
Copy Markdown
Collaborator

Summary

  • Add module-level docstring to model.py explaining the JAX-compatible cosmology classes and the default Planck15 cosmology
  • Expand LensingCosmology class docstring to list all method categories and note the xp convention
  • Add full docstring to Planck15 with Planck 2015 parameter values and reference

Test plan

  • Confirm Sphinx docs build without errors

🤖 Generated with Claude Code

…package

- Add module-level docstring to model.py explaining the JAX-compatible
  cosmology classes and the default Planck15 cosmology
- Expand LensingCosmology class docstring to list all categories of
  methods it provides and note that xp=numpy is the default
- Add full docstring to Planck15 class with the Planck 2015 parameter
  values and the reference to Planck Collaboration XIII (2016)

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@Jammy2211 Jammy2211 merged commit 7e6cc67 into main Mar 12, 2026
8 checks passed
@Jammy2211 Jammy2211 deleted the docs/cosmology branch April 2, 2026 11:42
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