docstring information to refer to sequence periods
I am on the process of documenting functions on the code and I would like to ask for advice on some descriptions to make sure anyone may understand it easilly.
I am using pycharm and reStructuredText as Docstring Format.
The most common variables on the functions are
- from_date
- to_date
En example of a function:
def db_info(from_date: datetime, to_date: datetime):
""" Retreive the database information for a period of time
:param start_date: When to begin the search
:type start_date: datetime
:param end_date: When to finish the search
:type end_date: datetime
:return: database information for a period of time
:rtype: DataFrame
# lines of code to retreive the data
1. Is there a best practices stablished to refer to a period of time?
I haven't found information on which way would be the best to document this
2. Do you find this comprehensible enough?
python python-3.x restructuredtext docstring
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
add a comment |
I am on the process of documenting functions on the code and I would like to ask for advice on some descriptions to make sure anyone may understand it easilly.
I am using pycharm and reStructuredText as Docstring Format.
The most common variables on the functions are
- from_date
- to_date
En example of a function:
def db_info(from_date: datetime, to_date: datetime):
""" Retreive the database information for a period of time
:param start_date: When to begin the search
:type start_date: datetime
:param end_date: When to finish the search
:type end_date: datetime
:return: database information for a period of time
:rtype: DataFrame
# lines of code to retreive the data
1. Is there a best practices stablished to refer to a period of time?
I haven't found information on which way would be the best to document this
2. Do you find this comprehensible enough?
python python-3.x restructuredtext docstring
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
add a comment |
I am on the process of documenting functions on the code and I would like to ask for advice on some descriptions to make sure anyone may understand it easilly.
I am using pycharm and reStructuredText as Docstring Format.
The most common variables on the functions are
- from_date
- to_date
En example of a function:
def db_info(from_date: datetime, to_date: datetime):
""" Retreive the database information for a period of time
:param start_date: When to begin the search
:type start_date: datetime
:param end_date: When to finish the search
:type end_date: datetime
:return: database information for a period of time
:rtype: DataFrame
# lines of code to retreive the data
1. Is there a best practices stablished to refer to a period of time?
I haven't found information on which way would be the best to document this
2. Do you find this comprehensible enough?
python python-3.x restructuredtext docstring
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
I am on the process of documenting functions on the code and I would like to ask for advice on some descriptions to make sure anyone may understand it easilly.
I am using pycharm and reStructuredText as Docstring Format.
The most common variables on the functions are
- from_date
- to_date
En example of a function:
def db_info(from_date: datetime, to_date: datetime):
""" Retreive the database information for a period of time
:param start_date: When to begin the search
:type start_date: datetime
:param end_date: When to finish the search
:type end_date: datetime
:return: database information for a period of time
:rtype: DataFrame
# lines of code to retreive the data
1. Is there a best practices stablished to refer to a period of time?
I haven't found information on which way would be the best to document this
2. Do you find this comprehensible enough?
python python-3.x restructuredtext docstring
python python-3.x restructuredtext docstring
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
edited Nov 16 '18 at 9:59
Vadim Kotov
4,82863549
4,82863549
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
asked Nov 16 '18 at 9:55
jalazbejalazbe
511318
511318
add a comment |
add a comment |
0
active
oldest
votes
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%2f53335341%2fdocstring-information-to-refer-to-sequence-periods%23new-answer', 'question_page');
}
);
Post as a guest
Required, but never shown
0
active
oldest
votes
0
active
oldest
votes
active
oldest
votes
active
oldest
votes
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%2f53335341%2fdocstring-information-to-refer-to-sequence-periods%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
