Styjun

How can I use my cell phone's light as a reading light?

Interpretation of non-significant results as "trends"

Is "wissen" the only verb in German to have an irregular present tense?

Appropriate conduit for several data cables underground over 300' run

Why am I getting unevenly-spread results when using $RANDOM?

Write a function

My previous employer committed a severe violation of the law and is also being sued by me. How do I explain the situation to future employers?

What exactly is a "murder hobo"?

Is there a method for differentiating informative comments from commented out code?

Why do airports remove/realign runways?

My professor has told me he will be the corresponding author. Will it hurt my future career?

This LM317 diagram doesn't make any sense to me

How do resistors generate different heat if we make the current fixed and changed the voltage and resistance? Notice the flow of charge is constant

Why won't the U.S. sign a peace treaty with North Korea?

QR codes, do people use them?

Passwordless authentication - how and when to invalidate a login code

How to understand flavors and when to use combination of them?

Sense of humor in your sci-fi stories

Can one block with a protection from color creature?

Is there a formal/better word than "skyrocket" for the given context?

Was it ever illegal to name a pig "Napoleon" in France?

What are the consequences for a developed nation to not accept any refugees?

Computer name naming convention for security

Why did Robert F. Kennedy loathe Lyndon B. Johnson?

Function summary in Google format not showing up in the quick documentation window in PyCharm

How can I tell PyCharm what type a parameter is expected to be?How to make PyCharm always show line numbersPyCharm shows unresolved references error for valid codepycharm quick documentation (CTRL+Q) not loading local documented filePython script runs perfect in PyCharm but in terminal don'tHow to automatically generate Python API documentation in PyCharmno pycharm database windowPyCharm and reStructuredText (Sphinx) documentation popupsHow to improve performance of Pycharm documentation fetchMake 'Google' the default docstring style for ALL projects PyCharm

.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;

0

PyCharm 2018.3 has an option to change your docstring format under File > Settings > Tools > Python Integrated Tools > Docstring Format

After selecting 'Google', I write code like:

def my_func(a, b):
 """
 Do something with a and b

 Args:
 a: first arg
 b: second arg

 Returns:
 something

 """
 pass

I want the summary i.e. "Do something with a and b" in addition to the arguments to show up in the quick documentation window but all I get is this

Am I doing something wrong or is this a bug in PyCharm?

python pycharm jetbrains-ide docstring

share|improve this question

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

add a comment | 

0

PyCharm 2018.3 has an option to change your docstring format under File > Settings > Tools > Python Integrated Tools > Docstring Format

After selecting 'Google', I write code like:

def my_func(a, b):
 """
 Do something with a and b

 Args:
 a: first arg
 b: second arg

 Returns:
 something

 """
 pass

I want the summary i.e. "Do something with a and b" in addition to the arguments to show up in the quick documentation window but all I get is this

Am I doing something wrong or is this a bug in PyCharm?

python pycharm jetbrains-ide docstring

share|improve this question

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

add a comment | 

PyCharm 2018.3 has an option to change your docstring format under File > Settings > Tools > Python Integrated Tools > Docstring Format

After selecting 'Google', I write code like:

def my_func(a, b):
 """
 Do something with a and b

 Args:
 a: first arg
 b: second arg

 Returns:
 something

 """
 pass

I want the summary i.e. "Do something with a and b" in addition to the arguments to show up in the quick documentation window but all I get is this

Am I doing something wrong or is this a bug in PyCharm?

python pycharm jetbrains-ide docstring

share|improve this question

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

def my_func(a, b):
 """
 Do something with a and b

 Args:
 a: first arg
 b: second arg

 Returns:
 something

 """
 pass

share|improve this question

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

share|improve this question

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

edited Mar 26 at 14:10

geekandglitter

13211 silver badge1313 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

asked Mar 25 at 22:24

Raghav MehtaRaghav Mehta

8111 silver badge99 bronze badges

1 Answer
1

active

oldest

votes

0

Using Pycharm Professional 2018.3.5, and copying your exact example, I was unable to reproduce the error. (I placed this response as an answer because it could serve to move your research closer to the answer.)

Here was my outcome from Quick Documentation:

def my_func(a: Any,
 b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something

share|improve this answer

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

add a comment | 

Your Answer

StackExchange.ifUsing("editor", function ()
StackExchange.using("externalEditor", function ()
StackExchange.using("snippets", function ()
StackExchange.snippets.init();
);
);
, "code-snippets");

StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "1"
;
initTagRenderer("".split(" "), "".split(" "), channelOptions);

StackExchange.using("externalEditor", function()
// Have to fire editor after snippets, if snippets enabled
if (StackExchange.settings.snippets.snippetsEnabled)
StackExchange.using("snippets", function()
createEditor();
);

else
createEditor();

);

function createEditor()
StackExchange.prepareEditor(
heartbeatType: 'answer',
autoActivateHeartbeat: false,
convertImagesToLinks: true,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: 10,
bindNavPrevention: true,
postfix: "",
imageUploader:
brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
allowUrls: true
,
onDemand: true,
discardSelector: ".discard-answer"
,immediatelyShowMarkdownHelp:true
);



);

draft saved

draft discarded

Sign up or log in

StackExchange.ready(function ()
StackExchange.helpers.onClickDraftSave('#login-link');
);

Sign up using Google

Sign up using Facebook

Sign up using Email and Password

Post as a guest

Name

Email

Required, but never shown

StackExchange.ready(
function ()
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f55347271%2ffunction-summary-in-google-format-not-showing-up-in-the-quick-documentation-wind%23new-answer', 'question_page');

);

Post as a guest

Name

Email

Required, but never shown

0

Using Pycharm Professional 2018.3.5, and copying your exact example, I was unable to reproduce the error. (I placed this response as an answer because it could serve to move your research closer to the answer.)

Here was my outcome from Quick Documentation:

def my_func(a: Any,
 b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something

share|improve this answer

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

add a comment | 

0

Using Pycharm Professional 2018.3.5, and copying your exact example, I was unable to reproduce the error. (I placed this response as an answer because it could serve to move your research closer to the answer.)

Here was my outcome from Quick Documentation:

def my_func(a: Any,
 b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something

share|improve this answer

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

add a comment | 

Using Pycharm Professional 2018.3.5, and copying your exact example, I was unable to reproduce the error. (I placed this response as an answer because it could serve to move your research closer to the answer.)

Here was my outcome from Quick Documentation:

def my_func(a: Any,
 b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something

share|improve this answer

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

def my_func(a: Any,
 b: Any) -> None
Do something with a and b
Params:
a – first arg
b – second arg
Returns:
something

share|improve this answer

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges

answered Mar 26 at 14:26

geekandglittergeekandglitter

13211 silver badge1313 bronze badges