Accessing function documentation The 2019 Stack Overflow Developer Survey Results Are InHow do I redefine a bash function in terms of old definition?how to get a variable's definition fileExpand variable in function definition in zshAccessing fish functions from perlGet specific result from functionDefining bash function dynamically using evalWhich of the following shell operations are performed inside the function body when running a function definition and when calling a function?Passing multiple arguments to sudo within functionHow shall I reuse a function in multiple scripts?Writing a script containing just one function definition v.s. moving the code in function body to the script?
Landlord wants to switch my lease to a "Land contract" to "get back at the city"
Is flight data recorder erased after every flight?
How to answer pointed "are you quitting" questioning when I don't want them to suspect
Is three citations per paragraph excessive for undergraduate research paper?
Manuscript was "unsubmitted" because the manuscript was deposited in Arxiv Preprints
Realistic Alternatives to Dust: What Else Could Feed a Plankton Bloom?
Why do UK politicians seemingly ignore opinion polls on Brexit?
What is the meaning of Triage in Cybersec world?
What do the Banks children have against barley water?
Spanish for "widget"
What are the motivations for publishing new editions of an existing textbook, beyond new discoveries in a field?
What is the steepest angle that a canal can be traversable without locks?
What is the motivation for a law requiring 2 parties to consent for recording a conversation
Limit to 0 ambiguity
How long do I have to send my income tax payment to the IRS?
What does "rabbited" mean/imply in this sentence?
Are USB sockets on wall outlets live all the time, even when the switch is off?
Does a dangling wire really electrocute me if I'm standing in water?
If the Wish spell is used to duplicate the effect of Simulacrum, are existing duplicates destroyed?
Does it makes sense to buy a new cycle to learn riding?
aging parents with no investments
What is the best strategy for white in this position?
Output the Arecibo Message
The difference between dialogue marks
Accessing function documentation
The 2019 Stack Overflow Developer Survey Results Are InHow do I redefine a bash function in terms of old definition?how to get a variable's definition fileExpand variable in function definition in zshAccessing fish functions from perlGet specific result from functionDefining bash function dynamically using evalWhich of the following shell operations are performed inside the function body when running a function definition and when calling a function?Passing multiple arguments to sudo within functionHow shall I reuse a function in multiple scripts?Writing a script containing just one function definition v.s. moving the code in function body to the script?
.everyoneloves__top-leaderboard:empty,.everyoneloves__mid-leaderboard:empty,.everyoneloves__bot-mid-leaderboard:empty margin-bottom:0;
Is there a way to access docstrings in Bash? How does one include a docstring in a function's definition in Bash?
More specifically how do I add and access docstrings to the following function?
funky()
echo "Violent and funky!"
bash shell-script shell function documentation
New contributor
add a comment |
Is there a way to access docstrings in Bash? How does one include a docstring in a function's definition in Bash?
More specifically how do I add and access docstrings to the following function?
funky()
echo "Violent and funky!"
bash shell-script shell function documentation
New contributor
add a comment |
Is there a way to access docstrings in Bash? How does one include a docstring in a function's definition in Bash?
More specifically how do I add and access docstrings to the following function?
funky()
echo "Violent and funky!"
bash shell-script shell function documentation
New contributor
Is there a way to access docstrings in Bash? How does one include a docstring in a function's definition in Bash?
More specifically how do I add and access docstrings to the following function?
funky()
echo "Violent and funky!"
bash shell-script shell function documentation
bash shell-script shell function documentation
New contributor
New contributor
edited 2 days ago
alias
New contributor
asked 2 days ago
aliasalias
205
205
New contributor
New contributor
add a comment |
add a comment |
1 Answer
1
active
oldest
votes
If you mean "Bash's equivalent of Python's docstrings" I'm afraid I have to disappoint you that there is no such thing.
However.. I must say that implementing an equivalent of the "docstrings" feature would make for a very interesting homework in order to learn Bash's programmable-completion facility along with how to override a builtin command such as help
to display either such "docstrings" or the normal builtin help
's output.
add a comment |
Your Answer
StackExchange.ready(function()
var channelOptions =
tags: "".split(" "),
id: "106"
;
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: false,
noModals: true,
showLowRepImageUploadWarning: true,
reputationToPostImages: null,
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
);
);
alias is a new contributor. Be nice, and check out our Code of Conduct.
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%2funix.stackexchange.com%2fquestions%2f511073%2faccessing-function-documentation%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
If you mean "Bash's equivalent of Python's docstrings" I'm afraid I have to disappoint you that there is no such thing.
However.. I must say that implementing an equivalent of the "docstrings" feature would make for a very interesting homework in order to learn Bash's programmable-completion facility along with how to override a builtin command such as help
to display either such "docstrings" or the normal builtin help
's output.
add a comment |
If you mean "Bash's equivalent of Python's docstrings" I'm afraid I have to disappoint you that there is no such thing.
However.. I must say that implementing an equivalent of the "docstrings" feature would make for a very interesting homework in order to learn Bash's programmable-completion facility along with how to override a builtin command such as help
to display either such "docstrings" or the normal builtin help
's output.
add a comment |
If you mean "Bash's equivalent of Python's docstrings" I'm afraid I have to disappoint you that there is no such thing.
However.. I must say that implementing an equivalent of the "docstrings" feature would make for a very interesting homework in order to learn Bash's programmable-completion facility along with how to override a builtin command such as help
to display either such "docstrings" or the normal builtin help
's output.
If you mean "Bash's equivalent of Python's docstrings" I'm afraid I have to disappoint you that there is no such thing.
However.. I must say that implementing an equivalent of the "docstrings" feature would make for a very interesting homework in order to learn Bash's programmable-completion facility along with how to override a builtin command such as help
to display either such "docstrings" or the normal builtin help
's output.
edited 2 days ago
answered 2 days ago
LL3LL3
1,1797
1,1797
add a comment |
add a comment |
alias is a new contributor. Be nice, and check out our Code of Conduct.
alias is a new contributor. Be nice, and check out our Code of Conduct.
alias is a new contributor. Be nice, and check out our Code of Conduct.
alias is a new contributor. Be nice, and check out our Code of Conduct.
Thanks for contributing an answer to Unix & Linux Stack Exchange!
- 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%2funix.stackexchange.com%2fquestions%2f511073%2faccessing-function-documentation%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
-bash, documentation, function, shell, shell-script