OriolAbril commented 2 years ago

Overview

We have to review and update all the docstrings of objects part of the public API (that is, that appear on the API reference section of the website). Why?

There are two main reasons:

Some functions are not documented correctly. i.e. pymc.Uniform didn't document that lower and upper bounds are optional and default to 0 and 1 respectively
Not following numpydoc results in non-ideal rendering. i.e. if there are no spaces around the colon that separates parameter name and type numpydoc+sphinx can't render it correctly and the type ends up being shown as bold text instead of being a link to the documentation of that object (which is particularly useful for functions taking or returning external objects such as ArviZ InferenceData or aesara TensorVariable).

Current view of the parameter section of pymc.Uniform

imatge

Before doing the changes described below

imatge

Details

A detailed tutorial on how to go about these updates is available at the PyMC-Data Umbrella sprint website (the page also has a video recorded by @reshamas showing an example PR).

How to choose what page to work on?

Look for pages that don't have hyperlinks in all their parameters. In case of doubt, don't hesitate to ask in this issue for pages to work on.

ravichikkam commented 2 years ago

I am working on the docstrings for weibull distribution.

EDIT (by @OriolAbril ): I moved the updated list to the initial comment so its easier to find for new people getting to this issue

jmloyola commented 2 years ago

Working on pm.Data.

cuchoi commented 2 years ago

Is this where the ConstantData and MutableData docs should appear? https://docs.pymc.io/en/v3/api/data.html. I can't find them.

Edit: There in v4 here https://docs.pymc.io/en/latest/api/data.html

chritter commented 2 years ago

Working on pymc.Exponential

cuchoi commented 2 years ago

Going to work on pymc.HyperGeometric

sagartomar commented 2 years ago

Working on pymc.Normal

lalitmusmade commented 2 years ago

Working on pymc.Flat

GallowayJ commented 2 years ago

Working on pymc.GaussianRandomWalk

areding commented 2 years ago

I'll start on pymc.Gamma

areding commented 2 years ago

Starting pymc.InverseGamma.

sagartomar commented 2 years ago

Starting with pymc.Beta

lalitmusmade commented 2 years ago

Working on pymc.HalfFlat

bdatko commented 2 years ago

@jlindbloom and I are working on Other utils

pibieta commented 2 years ago

I am working on the class docstrings inside the multivariate module.

vitaliset commented 2 years ago

Me and @pibieta are working on the rest of the classes docstrings inside the multivariate module.

DataUmbrellaPyMCSprint

Cc: @reshamas

daniel-saunders-phil commented 2 years ago

working on docstring for pm.simulator

rowan-schaefer commented 2 years ago

I can take smc

daniel-saunders-phil commented 2 years ago

I can take smc

maybe we could work together on it! I've been working with a little bit this week and have a number of ideas. Do you know a good technique to co-write a PR?

rowan-schaefer commented 2 years ago

I'll message you!

daniel-saunders-phil commented 2 years ago

I'll take pm.AR

rowan-schaefer commented 2 years ago

Currently working on pymc.variational.inference!