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.

Arguments list in DocString broke after couple of latest updates

See original GitHub issue

Environment data

VS Code version: 1.36.1
Extension version (available under the Extensions sidebar): 2019.6.24221
OS and version: Mac OS Mojave
Python version (& distribution if applicable, e.g. Anaconda):3.7.3
Type of virtual environment used (N/A | venv | virtualenv | conda | …): NA
Relevant/affected Python packages and their versions: NA
Jedi or Language Server? (i.e. what is "python.jediEnabled" set to; more info #3977): XXX

Expected behaviour

Arguments list should be shown in individual lines

Actual behaviour

All arguments appear in same line

Steps to reproduce:

Create a function & write a doc string with couple of arguments list

Actual : Screenshot 2019-07-24 at 2 10 07 pm

Expected : (I have manually included a \n to demonstrate the expected behaviour) Screenshot 2019-07-24 at 2 11 13 pm

Issue Analytics

State:
Created 4 years ago
Comments:11 (1 by maintainers)

Top GitHub Comments

1reaction

sleighsoftcommented, Oct 10, 2019

Oh ok, thanks for checking back. Done so 😃

1reaction

RaviChandraVeeramachanenicommented, Aug 13, 2019

Hi @kimadeline With the latest update, it seems to work now. But let me test it throughly before closing the issue.

Top Results From Across the Web

Argument list is shown in the docstring area, messes up ...

Just show a list of arguments with their default values, one below the other, the current one at the top of the list,...

How to document a method with parameter(s)? - Stack Overflow

EDIT: PEP 257 gives this example: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arguments: real -- the real part (default 0.0) imag...

Python Docstring: Documenting And Introspecting Functions

This tutorial explains what is Python Docstring and how to use it to document Python functions with examples.

doctest — Test interactive Python examples — Python 3.11.1 ...

Return a list of the DocTest s that are defined by obj's docstring, or by any of its contained objects' docstrings. The optional...

Style guide — numpydoc v1.6.0rc1.dev0 Manual

This document describes the syntax and best practices for docstrings used with ... arguments to `metric`: refer to each metric documentation for a...