Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Add inline example to psislw #1057

Closed
canyon289 opened this issue Feb 9, 2020 · 6 comments
Closed

Add inline example to psislw #1057

canyon289 opened this issue Feb 9, 2020 · 6 comments

Comments

@canyon289
Copy link
Member

Add inline docs to psislw. @pawanakhil You're welcome to claim this one first!

https://arviz-devs.github.io/arviz/generated/arviz.psislw.html#arviz.psislw

@akhill10
Copy link

Yeah , I will work on this .

@canyon289
Copy link
Member Author

canyon289 commented Feb 11, 2020

Great! This PR is a really good example on how to add extra examples to docs. https://github.com/arviz-devs/arviz/pull/937/files

Instructions on how to compile the docs should be in CONTRIBUTING.md if you run into issues feel free to reach out!

@smit-s
Copy link
Contributor

smit-s commented Mar 22, 2020

@canyon289 This issue doesn't seem to have been addressed. Can I work on this?

@aloctavodia
Copy link
Contributor

@smit-s I think you can work on this. Thanks in advance!

@smit-s
Copy link
Contributor

smit-s commented Mar 26, 2020

@aloctavodia Inline example does not exist for r2_score. Shall I add an example for it as well?

@OriolAbril
Copy link
Member

Yes! We created independent issues for some functions to make the tasks more accessible, but all functions missing it would welcome an example in the docstring, see #491. (exceptions would probably be from_xyz methods if compiling and running the model takes a lot of time as it would slow doc generation)

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants