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_khat docstring

See original GitHub issue

Add links to the related functions and classes to all the places where they are mentioned in the plot_khat 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/khatplot.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. Follow the same process for kwargs.

See also section

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

  1. psislw

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:7 (2 by maintainers)

github_iconTop GitHub Comments

1reaction
Weijun-Hcommented, Oct 29, 2021

Hi Rosheen, I am just starting to work on it. Please give me another two days.

Rosheen Naeem @.***> 于2021年10月29日周五 上午11:08写道:

Hello @Weijun-H https://github.com/Weijun-H, are you working on this issue? Please let me know if you are stuck on anything, so I can help you.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/arviz-devs/arviz/issues/1841#issuecomment-954579323, or unsubscribe https://github.com/notifications/unsubscribe-auth/AE2UFL76LKKRESBANPLZWDDUJJQCXANCNFSM5FIW4JAQ . Triage notifications on the go with GitHub Mobile for iOS https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675 or Android https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub.

0reactions
roshnaeemcommented, Oct 29, 2021

Sure, take your time. I was just checking. Thank you for replying.

Read more comments on GitHub >

github_iconTop Results From Across the Web

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 >
How to Use Python Docstrings for Effective Code Documentation
This tutorial will show you how using docstrings. ... Now imagine using these packages without any reference. We would need to dig into ......
Read more >
PEP 257 – Docstring Conventions
This PEP documents the semantics and conventions associated with Python docstrings. Rationale. The aim of this PEP is to standardize the high- ...
Read more >
Python Docstrings (With Examples) - Programiz
The docstrings for Python script should document the script's functions and command-line syntax as a usable message. It should serve as a quick...
Read more >
Example Google Style Python Docstrings - Napoleon
coding: utf-8 -*- """Example Google style docstrings. This module demonstrates documentation as specified by the `Google Python Style Guide`_.
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