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

Add docs references to plot_joint docstring #1846

Closed
roshnaeem opened this issue Oct 4, 2021 · 3 comments · Fixed by #1856
Closed

Add docs references to plot_joint docstring #1846

roshnaeem opened this issue Oct 4, 2021 · 3 comments · Fixed by #1856
Assignees
Labels
Beginner Hacktoberfest User Documentation Documentation outside of the codebase

Comments

@roshnaeem
Copy link
Contributor

Add links to the related functions and classes to all the places where they are mentioned in the plot_joint docstring.

Sample PR:

You can see #1816 for the function, plot_autocorr.

Source File

Source file: https://github.com/arviz-devs/arviz/blob/main/arviz/plots/jointplot.py

How to add links

Add the links in the docstring of doc. You can also check the docstring by going to the [source].

backend_kwargs, marginal_kwargs and joint_kwargs

For adding backend_kwargs as they have been added in #1816, see Adding backend_kwargs guide. Follow the same process for marginal_kwargs and joint_kwargs.

See also section

Add the following functions in the "See also" section:

  1. plot_pair

See Adding "see also" section for more details.

Checking the preview of docs

For checking the preview of docs, you don't need t set up the project on your local machine. Just follow the checking the preview guide.

@roshnaeem roshnaeem added Beginner Hacktoberfest User Documentation Documentation outside of the codebase labels Oct 4, 2021
@nhtsai
Copy link
Contributor

nhtsai commented Oct 6, 2021

Hi, can I try working on this?

@roshnaeem
Copy link
Contributor Author

yeah, sure. I have assigned this issue to you. Let me know if you have any questions.

@roshnaeem
Copy link
Contributor Author

⚠️ Always create a new branch for changes. Don't make any changes to the main branch.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Beginner Hacktoberfest User Documentation Documentation outside of the codebase
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants