Updated docstrings in pymc.step_methods.metropolis for BinaryGibbsMetropolis to follow numpydoc
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
- [x] Checked that the pre-commit linting/style checks pass
- [x] Included tests that prove the fix is effective or that the new feature works
- [x] Added necessary documentation (docstrings and/or example notebooks)
- [ ] If you are a pro: each commit corresponds to a relevant logical change
Type of change
- [ ] New feature / enhancement
- [ ] Bug fix
- [x] Documentation
- [ ] Maintenance
- [ ] Other (please specify):
📚 Documentation preview 📚: https://pymc--7212.org.readthedocs.build/en/7212/
]
: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.
Can we merge this? Or do we need to wait for the type hint thing?
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.