Skip to content
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

Improve docstrings in GP module #6652

Merged
merged 1 commit into from
Apr 6, 2023

Conversation

daniel-saunders-phil
Copy link
Contributor

@daniel-saunders-phil daniel-saunders-phil commented Apr 6, 2023

This is a new PR that finishes the work from #6609. I ran into difficulties to resolve git issues and Oriol and I decided opening a new PR would be the best bet.

A summary of doc changes:

  • implemented style changes
  • properly named object types like string -> str,
  • fixed references to other pymc objects like Zero -> ~pymc.gp.mean.Zero
  • clarified default arguments where they weren't listed
  • added description for some missing arguments like the model argument in the predict methods

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

@daniel-saunders-phil daniel-saunders-phil marked this pull request as ready for review April 6, 2023 15:50
@OriolAbril OriolAbril added the docs label Apr 6, 2023
@OriolAbril OriolAbril changed the title a fresh file that contains all gp doc changes Improve docstrings in GP module Apr 6, 2023
@OriolAbril OriolAbril merged commit 30c9179 into pymc-devs:main Apr 6, 2023
@daniel-saunders-phil daniel-saunders-phil deleted the GP_docs branch August 9, 2023 22:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants