question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Add docs references to plot_lm docstring

See original GitHub issue

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

Sample PR:

You can see https://github.com/arviz-devs/arviz/pull/1816 for the function, plot_autocorr.

Source File

Source file: https://github.com/arviz-devs/arviz/blob/main/arviz/plots/lmplot.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 and kwargs

For adding backend_kwargs as they have been added in #1816, see Adding backend_kwargs guide.

See also section

Add the following functions in the “See also” section:

  1. plot_ts
  2. plot_ppc

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.

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
arushi-mittalcommented, Oct 25, 2021

Yes @roshnaeem I am on it! Hoping to be done in the next couple of days!

0reactions
roshnaeemcommented, Oct 25, 2021

Thank you @arushi-mittal. Let me know if you need any help.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Writing documentation — Matplotlib 3.6.2 documentation
Function arguments and keywords within docstrings should be referred to using the *emphasis* role. This will keep Matplotlib's documentation consistent with ...
Read more >
Python Docstrings Tutorial : Examples & Format for Pydoc ...
See Python Docstrings. Learn about the different types of docstrings & various docstring formats like Sphinx, Numpy, and Pydoc with examples now.
Read more >
Source code for statsmodels.graphics.regressionplots
[docs]def plot_fit(results, exog_idx, y_true=None, ax=None, **kwargs): """Plot fit against one regressor. This creates one graph with the scatterplot of ...
Read more >
A quick and easy function to plot lm() results with ggplot2 in R
Here is a quick and dirty solution with ggplot2 to create the following plot: Let's try it out using the iris dataset in...
Read more >
Documenting Python APIs with docstrings
We use Python docstrings to create reference documentation for our Python APIs. Docstrings are read by developers, interactive Python users, and readers of ......
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found