pymc icon indicating copy to clipboard operation
pymc copied to clipboard

Updated docstrings in pymc.step_methods.metropolis for BinaryGibbsMetropolis to follow numpydoc

Open HangenYuu opened this issue 1 year ago • 3 comments

Description

First time contributor to open-source and the project for me. I updated the docstring of BinaryGibbsMetropolis to follow numpydoc format. I also updated the Metropolis init while trying to check how Sphinx works (deleting it would be pointless so I keep it there).

Related Issue

  • [ ] Closes #
  • [x] Related to #5459

Checklist

Type of change

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

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

HangenYuu avatar Mar 22 '24 13:03 HangenYuu

Thank You Banner] :sparkling_heart: Thanks for opening this pull request! :sparkling_heart: 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.

welcome[bot] avatar Mar 22 '24 13:03 welcome[bot]

Can we merge this? Or do we need to wait for the type hint thing?

aloctavodia avatar Jul 16 '24 12:07 aloctavodia

I think we can use

mode : string or Mode

Let's use this and merge, once we agree on https://github.com/pymc-devs/pytensor/issues/690 about the best way to link to that we can add Mode to the numpydoc aliases.

OriolAbril avatar Jul 16 '24 12:07 OriolAbril