Question 130087 in Visual Studio Code Question posted in
View the official documentation.

Visual Studio Code – Why does this Python docstring not have newlines in the VS Code hover info?

I have this docstring:

def get_crypto_price(crypto: str, currency: str, max_attempts: int = 3) -> float | None:
   """
   Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

   Args:
      crypto (str): The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
      currency (str): The currency to retrieve the price in (e.g., 'usd').  
      max_attempts (int): The maximum number of attempts to make before giving up (default: 3).

   Returns:
      float | None: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
   """

But it shows up like this in VS Code, with no newline between the currency and max_attempts lines:
docsctring context menu

How do I get the max_attempts line to be on a new line in the hover info?

Tags:

3

Answers


  1. 0

    Python docs generally use reStructuredText as their markup format. What you’ve written with your "Args" and "Returns" are definition lists, where paragraphs in the definition section are separated by empty lines, and two lines in the definition section with no empty line between them are treated as part of the same paragraph. So what I find actually surprising is the fact that VS Code puts a newline in the hover info between the first two lines of your "Args" definition section (and I don’t know why it does that. Either it’s a bug, or I’m missing something).

    If you want to do things the way Python recommends for Sphinx usage, see https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#info-field-lists, https://devguide.python.org/documentation/markup/#quick-reference, https://devguide.python.org/documentation/markup/#directives, and https://devguide.python.org/documentation/markup/#information-units.

    Which would look something like this:

    """
Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

:param crypto: The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
:param currency: The currency to retrieve the price in (e.g., 'usd').  
:param max_attempts: The maximum number of attempts to make before giving up (default: 3).
:return: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
"""

    If you don’t care about the Sphinx-friendly way of writing documentation, you can just turn your definition section into a bullet list. Ex.

    Args:
    - crypto (str): The cryptocurrency to retrieve the price for (e.g., 'bitcoin').
    - currency (str): The currency to retrieve the price in (e.g., 'usd').
    - max_attempts (int): The maximum number of attempts to make before giving up (default: 3).
    Login or Signup to reply.
  2. 0

    As @user said, Python documentation use reStructuredText and the it looks like this:

    from typing import Union

def get_crypto_price(crypto: str, currency: str, max_attempts: int = 3) -> Union[float, None]:
   """
   Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

   :param crypto: The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
   :param currency: The currency to retrieve the price in (e.g., 'usd').  
   :param max_attempts: The maximum number of attempts to make before giving up (default: 3).
   :return: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
   """

    Notes

    • The type annotations are not included in the docstring
    • As a matter of style, I use Union[float, None] to denote the return types
    Login or Signup to reply.
  3. 0

    Method one

    Use n newline at the end of a sentence

    def get_crypto_price(crypto: str, currency: str, max_attempts: int = 3) -> float | None:
   """
   Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

   Args:
      crypto (str): The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
      currency (str): The currency to retrieve the price in (e.g., 'usd'). n 
      max_attempts (int): The maximum number of attempts to make before giving up (default: 3).

   Returns:
      float | None: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
   """

    enter image description here

    Method two

    Add spaces at the beginning of the sentence

    def get_crypto_price(crypto: str, currency: str, max_attempts: int = 3) -> float | None:
   """
   Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

   Args:
      crypto (str): The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
      currency (str): The currency to retrieve the price in (e.g., 'usd'). 
       max_attempts (int): The maximum number of attempts to make before giving up (default: 3).

   Returns:
      float | None: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
   """

    enter image description here

    Method three

    Add a blank line between every two lines (can be used in conjunction with method two)

    def get_crypto_price(crypto: str, currency: str, max_attempts: int = 3) -> float | None:
   """
   Retrieves the price of a cryptocurrency in a specified currency using the CoinGecko API.

   Args:
      crypto (str): The cryptocurrency to retrieve the price for (e.g., 'bitcoin').  
      currency (str): The currency to retrieve the price in (e.g., 'usd'). 
      
      max_attempts (int): The maximum number of attempts to make before giving up (default: 3).

   Returns:
      float | None: The price of the cryptocurrency in the specified currency, or None if the price could not be retrieved.
   """

    enter image description here

    Login or Signup to reply.
Please signup or login to give your own answer.

Back To Top
Search