How do you add function guides to python when writing a module?
I was recently writing a python module with many functions, and I was wondering if it was possible, and if so, how can I implement these function guides as shown in the picture below. Thanks in advance!
python python-3.x function functional-programming python-idle
asked Nov 20 '18 at 4:27
JakeJake
287
add a comment |
I was recently writing a python module with many functions, and I was wondering if it was possible, and if so, how can I implement these function guides as shown in the picture below. Thanks in advance!
python python-3.x function functional-programming python-idle
asked Nov 20 '18 at 4:27
JakeJake
287
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45
add a comment |
I was recently writing a python module with many functions, and I was wondering if it was possible, and if so, how can I implement these function guides as shown in the picture below. Thanks in advance!
python python-3.x function functional-programming python-idle
asked Nov 20 '18 at 4:27
JakeJake
287
I was recently writing a python module with many functions, and I was wondering if it was possible, and if so, how can I implement these function guides as shown in the picture below. Thanks in advance!
python python-3.x function functional-programming python-idle
python python-3.x function functional-programming python-idle
asked Nov 20 '18 at 4:27
JakeJake
287
asked Nov 20 '18 at 4:27
JakeJake
287
asked Nov 20 '18 at 4:27
JakeJake
287
asked Nov 20 '18 at 4:27
JakeJake
287
asked Nov 20 '18 at 4:27
JakeJake
287
287
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45
add a comment |
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45
add a comment |
1 Answer
1
active
oldest
votes
These are function docstrings, to define them when writing a function, simply add a multi-line string to the start of the function
def function():
'''This function does nothing'''
pass
To access the docstring, use function.__doc__ or help(function)
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
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%2f53386227%2fhow-do-you-add-function-guides-to-python-when-writing-a-module%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
These are function docstrings, to define them when writing a function, simply add a multi-line string to the start of the function
def function():
'''This function does nothing'''
pass
To access the docstring, use function.__doc__ or help(function)
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
add a comment |
These are function docstrings, to define them when writing a function, simply add a multi-line string to the start of the function
def function():
'''This function does nothing'''
pass
To access the docstring, use function.__doc__ or help(function)
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
add a comment |
These are function docstrings, to define them when writing a function, simply add a multi-line string to the start of the function
def function():
'''This function does nothing'''
pass
To access the docstring, use function.__doc__ or help(function)
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
These are function docstrings, to define them when writing a function, simply add a multi-line string to the start of the function
def function():
'''This function does nothing'''
pass
To access the docstring, use function.__doc__ or help(function)
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
answered Nov 20 '18 at 4:38
William LeeWilliam Lee
187210
187210
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
add a comment |
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
I have these docstrings in my functions, although none of them display when opening the brackets (refer to the picture in original question)
– Jake
Nov 20 '18 at 4:57
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
@Jake As Burhan Khalid said, tooltips are features of your editor or IDE. However, I do get tooltips on IDLE image
– William Lee
Nov 20 '18 at 5:35
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%2f53386227%2fhow-do-you-add-function-guides-to-python-when-writing-a-module%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
Just to note that to display the tooltip (in your screenshot), this is a feature of the shell. If you are writing code in another program, you may not get those hints.
– Burhan Khalid
Nov 20 '18 at 4:45