Do the triple-quoted (docstring) messages in Python appear while typing in IDEs other than IDLE?
I usually write scripts to calculate or process things for my own consumption. Now I'm trying to write scripts for others.
I use both IDLE and a terminal, but I like just like the IDLE interface and find it more helpful. Today I "discovered" that I can add triple-quoted text under class
and def
and see them in real time when using IDLE, and I realize I can use those to help others know how to use these classes and methods.
But if run from a terminal this is all lost.
Question: Is it only IDLE users who are seeing these cues while they are typing a line that uses the class or method, or is this something that people using terminal could see while typing if they wanted to? I know that one could type A.__doc__
to see it for example, but the pop-up window is really convenient and helpful.
class A(object):
"""hey A!"""
def __init__(self, x):
"""hey __int__!"""
self.x = x
def sqrx(self):
"""hey sqrx!"""
print self.x**2
(just to see what would happen if)
But if I do this from a terminal all these prompts disappear.
nothing.
python ide python-idle
add a comment |
I usually write scripts to calculate or process things for my own consumption. Now I'm trying to write scripts for others.
I use both IDLE and a terminal, but I like just like the IDLE interface and find it more helpful. Today I "discovered" that I can add triple-quoted text under class
and def
and see them in real time when using IDLE, and I realize I can use those to help others know how to use these classes and methods.
But if run from a terminal this is all lost.
Question: Is it only IDLE users who are seeing these cues while they are typing a line that uses the class or method, or is this something that people using terminal could see while typing if they wanted to? I know that one could type A.__doc__
to see it for example, but the pop-up window is really convenient and helpful.
class A(object):
"""hey A!"""
def __init__(self, x):
"""hey __int__!"""
self.x = x
def sqrx(self):
"""hey sqrx!"""
print self.x**2
(just to see what would happen if)
But if I do this from a terminal all these prompts disappear.
nothing.
python ide python-idle
1
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
1
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18
add a comment |
I usually write scripts to calculate or process things for my own consumption. Now I'm trying to write scripts for others.
I use both IDLE and a terminal, but I like just like the IDLE interface and find it more helpful. Today I "discovered" that I can add triple-quoted text under class
and def
and see them in real time when using IDLE, and I realize I can use those to help others know how to use these classes and methods.
But if run from a terminal this is all lost.
Question: Is it only IDLE users who are seeing these cues while they are typing a line that uses the class or method, or is this something that people using terminal could see while typing if they wanted to? I know that one could type A.__doc__
to see it for example, but the pop-up window is really convenient and helpful.
class A(object):
"""hey A!"""
def __init__(self, x):
"""hey __int__!"""
self.x = x
def sqrx(self):
"""hey sqrx!"""
print self.x**2
(just to see what would happen if)
But if I do this from a terminal all these prompts disappear.
nothing.
python ide python-idle
I usually write scripts to calculate or process things for my own consumption. Now I'm trying to write scripts for others.
I use both IDLE and a terminal, but I like just like the IDLE interface and find it more helpful. Today I "discovered" that I can add triple-quoted text under class
and def
and see them in real time when using IDLE, and I realize I can use those to help others know how to use these classes and methods.
But if run from a terminal this is all lost.
Question: Is it only IDLE users who are seeing these cues while they are typing a line that uses the class or method, or is this something that people using terminal could see while typing if they wanted to? I know that one could type A.__doc__
to see it for example, but the pop-up window is really convenient and helpful.
class A(object):
"""hey A!"""
def __init__(self, x):
"""hey __int__!"""
self.x = x
def sqrx(self):
"""hey sqrx!"""
print self.x**2
(just to see what would happen if)
But if I do this from a terminal all these prompts disappear.
nothing.
python ide python-idle
python ide python-idle
edited Jan 1 at 13:42
uhoh
asked Dec 31 '18 at 15:03
uhohuhoh
1,4451938
1,4451938
1
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
1
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18
add a comment |
1
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
1
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18
1
1
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
1
1
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18
add a comment |
1 Answer
1
active
oldest
votes
The "triple-quoted messages" are docstrings, and they appear in different contexts.
For example:
When hitting ctrl+q (or whatever key is bound to the "Quick Documentation" action) in PyCharm:
There is also an option to display the quick documentation pop-up while typing.
When calling
help
on the function:
>> help(foo)
Help on function foo in module __main__:
foo()
foo's docstring
I can not tell you about other IDEs as I don't use them.
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
});
}
});
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
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53988820%2fdo-the-triple-quoted-docstring-messages-in-python-appear-while-typing-in-ides%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
1 Answer
1
active
oldest
votes
1 Answer
1
active
oldest
votes
active
oldest
votes
active
oldest
votes
The "triple-quoted messages" are docstrings, and they appear in different contexts.
For example:
When hitting ctrl+q (or whatever key is bound to the "Quick Documentation" action) in PyCharm:
There is also an option to display the quick documentation pop-up while typing.
When calling
help
on the function:
>> help(foo)
Help on function foo in module __main__:
foo()
foo's docstring
I can not tell you about other IDEs as I don't use them.
add a comment |
The "triple-quoted messages" are docstrings, and they appear in different contexts.
For example:
When hitting ctrl+q (or whatever key is bound to the "Quick Documentation" action) in PyCharm:
There is also an option to display the quick documentation pop-up while typing.
When calling
help
on the function:
>> help(foo)
Help on function foo in module __main__:
foo()
foo's docstring
I can not tell you about other IDEs as I don't use them.
add a comment |
The "triple-quoted messages" are docstrings, and they appear in different contexts.
For example:
When hitting ctrl+q (or whatever key is bound to the "Quick Documentation" action) in PyCharm:
There is also an option to display the quick documentation pop-up while typing.
When calling
help
on the function:
>> help(foo)
Help on function foo in module __main__:
foo()
foo's docstring
I can not tell you about other IDEs as I don't use them.
The "triple-quoted messages" are docstrings, and they appear in different contexts.
For example:
When hitting ctrl+q (or whatever key is bound to the "Quick Documentation" action) in PyCharm:
There is also an option to display the quick documentation pop-up while typing.
When calling
help
on the function:
>> help(foo)
Help on function foo in module __main__:
foo()
foo's docstring
I can not tell you about other IDEs as I don't use them.
edited Dec 31 '18 at 15:21
answered Dec 31 '18 at 15:11
DeepSpaceDeepSpace
38.6k44470
38.6k44470
add a comment |
add a comment |
Thanks for contributing an answer to Stack Overflow!
- Please be sure to answer the question. Provide details and share your research!
But avoid …
- Asking for help, clarification, or responding to other answers.
- Making statements based on opinion; back them up with references or personal experience.
To learn more, see our tips on writing great answers.
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
Required, but never shown
StackExchange.ready(
function () {
StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53988820%2fdo-the-triple-quoted-docstring-messages-in-python-appear-while-typing-in-ides%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
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
Required, but never shown
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
Required, but never shown
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
Sign up using Google
Sign up using Facebook
Sign up using Email and Password
Post as a guest
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
Required, but never shown
1
I don't think you can do something like pop up in terminals because Python REPL is thinked to work with terminals and if this one doesn't give features that it can use for creating suggestion in pop up/notifications than REPL can't. And I'm sure that basic terminal like cmd and bash don't have some feature for this.
– Iulian
Dec 31 '18 at 15:12
1
It's an IDE thing. Dumb terminals generally don't.
– martineau
Dec 31 '18 at 15:18