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

ENH: Add code example to Potential docstrings #6399

Closed
ricardoV94 opened this issue Dec 15, 2022 · 9 comments
Closed

ENH: Add code example to Potential docstrings #6399

ricardoV94 opened this issue Dec 15, 2022 · 9 comments

Comments

@ricardoV94
Copy link
Member

ricardoV94 commented Dec 15, 2022

https://www.pymc.io/projects/docs/en/latest/api/generated/pymc.Potential.html

Note: This is labeled beginner friendly because it is self-contained, it requires modifiying only a single file and not too many lines either. It does require being a PyMC user who knows how to use pymc.Potential. Thus, it is a good choice for someone who is already a PyMC user but has never contributed to the library or to any open source library, while at the same time it is a bad choice for an experienced oss contributor who has never used PyMC.

@yashvmanmode
Copy link

Hi @ricardoV94

I can solve this issue. Do we have to just provide a code example of pymc.Potential() function?
If yes then where I can update the code?

Thank you

@reshamas
Copy link
Contributor

Hi @ricardoV94

I can solve this issue. Do we have to just provide a code example of pymc.Potential() function? If yes then where I can update the code?

Thank you

One of the learning steps in contributing is to explore the code base and find which file(s) need to be updated. Want to give that a try? ;)

@yashvmanmode
Copy link

yashvmanmode commented Jan 27, 2023

Hi @reshamas

Yes I want to give it a try, will you help me so that i will learn how to explore the code base

@reshamas
Copy link
Contributor

To learn more about the pymc project, check out this playlist:
https://www.youtube.com/playlist?list=PLBKcU7Ik-ir99uTvN0315hIVLuyj4Q1Gt

@reshamas
Copy link
Contributor

@ricardoV94 @OriolAbril
I removed the "beginner friendly" label for this one.

cc: @SangamSwadiK @BerylKanali

@yashvmanmode
Copy link

To learn more about the pymc project, check out this playlist:
https://www.youtube.com/playlist?list=PLBKcU7Ik-ir99uTvN0315hIVLuyj4Q1Gt

Thank you @reshamas for your help, I will be connected to get some help and give others some help :)

@ricardoV94
Copy link
Member Author

@ricardoV94 @OriolAbril
I removed the "beginner friendly" label for this one.

cc: @SangamSwadiK @BerylKanali

I think that is setting the bar for beginner friendly issues a bit too low.

@OriolAbril
Copy link
Member

Added the label again and extended the description

@larryshamalama
Copy link
Member

Closed by #6559

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

5 participants