Accessing function documentationHow do I redefine a bash function in terms of old definition?how to get a...

Is there a name of the flying bionic bird?

Is it legal to have the "// (c) 2019 John Smith" header in all files when there are hundreds of contributors?

Is "plugging out" electronic devices an American expression?

Landlord wants to switch my lease to a "Land contract" to "get back at the city"

Manga about a female worker who got dragged into another world together with this high school girl and she was just told she's not needed anymore

Pristine Bit Checking

COUNT(*) or MAX(id) - which is faster?

Where to refill my bottle in India?

Doomsday-clock for my fantasy planet

Add an angle to a sphere

Eliminate empty elements from a list with a specific pattern

Why do we use polarized capacitors?

What does 'script /dev/null' do?

What do the Banks children have against barley water?

Patience, young "Padovan"

Are objects structures and/or vice versa?

Information to fellow intern about hiring?

extract characters between two commas?

What do you call something that goes against the spirit of the law, but is legal when interpreting the law to the letter?

When blogging recipes, how can I support both readers who want the narrative/journey and ones who want the printer-friendly recipe?

Is it wise to focus on putting odd beats on left when playing double bass drums?

Where else does the Shulchan Aruch quote an authority by name?

Re-submission of rejected manuscript without informing co-authors

How did the USSR manage to innovate in an environment characterized by government censorship and high bureaucracy?



Accessing function documentation


How 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;
}







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!"
}









share|improve this question









New contributor




alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
Check out our Code of Conduct.



























    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!"
    }









    share|improve this question









    New contributor




    alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
    Check out our Code of Conduct.























      0












      0








      0


      2






      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!"
      }









      share|improve this question









      New contributor




      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.












      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






      share|improve this question









      New contributor




      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.











      share|improve this question









      New contributor




      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      share|improve this question




      share|improve this question








      edited yesterday







      alias













      New contributor




      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.









      asked yesterday









      aliasalias

      205




      205




      New contributor




      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.





      New contributor





      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






      alias is a new contributor to this site. Take care in asking for clarification, commenting, and answering.
      Check out our Code of Conduct.






















          1 Answer
          1






          active

          oldest

          votes


















          0














          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.






          share|improve this answer


























            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.










            draft saved

            draft discarded


















            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









            0














            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.






            share|improve this answer






























              0














              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.






              share|improve this answer




























                0












                0








                0







                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.






                share|improve this answer















                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.







                share|improve this answer














                share|improve this answer



                share|improve this answer








                edited yesterday

























                answered yesterday









                LL3LL3

                1,1297




                1,1297






















                    alias is a new contributor. Be nice, and check out our Code of Conduct.










                    draft saved

                    draft discarded


















                    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.




                    draft saved


                    draft discarded














                    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





















































                    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







                    Popular posts from this blog

                    Taj Mahal Inhaltsverzeichnis Aufbau | Geschichte | 350-Jahr-Feier | Heutige Bedeutung | Siehe auch |...

                    Baia Sprie Cuprins Etimologie | Istorie | Demografie | Politică și administrație | Arii naturale...

                    Nicolae Petrescu-Găină Cuprins Biografie | Opera | In memoriam | Varia | Controverse, incertitudini...