Skip to content

Updated pymc.model.transform.conditioning.do docstring #7782

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

JeanVanDyk
Copy link

@JeanVanDyk JeanVanDyk commented May 13, 2025

Description

Added spaces between argument's name and its colon.

Related Issue

Checklist

Type of change

  • New feature / enhancement
  • Bug fix
  • Documentation
  • [ x] Maintenance
  • Other (please specify):

📚 Documentation preview 📚: https://pymc--7782.org.readthedocs.build/en/7782/

Copy link

welcome bot commented May 13, 2025

Thank You Banner]
💖 Thanks for opening this pull request! 💖 The PyMC community really appreciates your time and effort to contribute to the project. Please make sure you have read our Contributing Guidelines and filled in our pull request template to the best of your ability.

Copy link
Member

@OriolAbril OriolAbril left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the PR!

You should update the type information to be actual types and to follow numpydoc too. I have done one in a comment but detailed description of the changes needed is availalbe at https://pymc-data-umbrella.xyz/en/latest/contributing/tutorials/docstring_tutorial.html#edit-the-docstring, and you can check the preview of the rendered docstring to double check parsing is working as expected and there are no "pink" code formatted elements in the type info. Also note that changes are needed in both parameters and returns sections.

model: PyMC Model
vars_to_interventions: Dict of variable or name to TensorLike
model : PyMC Model
vars_to_interventions : Dict of variable or name to TensorLike
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
vars_to_interventions : Dict of variable or name to TensorLike
vars_to_interventions : mapping of {str or TensorVariable : tensor_like}

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