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?

Are there any other methods to apply to solving simultaneous equations?

Did 3000BC Egyptians use meteoric iron weapons?

Delete all lines which don't have n characters before delimiter

How are circuits which use complex ICs normally simulated?

How to check whether the reindex working or not in Magento?

Worn-tile Scrabble

Can you compress metal and what would be the consequences?

The difference between dialogue marks

How to type this arrow in math mode?

Is an up-to-date browser secure on an out-of-date OS?

How to answer pointed "are you quitting" questioning when I don't want them to suspect

What does Linus Torvalds mean when he says that Git "never ever" tracks a file?

Where to refill my bottle in India?

How to notate time signature switching consistently every measure

Right tool to dig six foot holes?

Multiply Two Integer Polynomials

Am I thawing this London Broil safely?

If a Druid sees an animal’s corpse, can they Wild Shape into that animal?

Why was M87 targetted for the Event Horizon Telescope instead of Sagittarius A*?

Is there a symbol for a right arrow with a square in the middle?

Button changing it's text & action. Good or terrible?

What to do when moving next to a bird sanctuary with a loosely-domesticated cat?

Identify boardgame from Big movie

Can we generate random numbers using irrational numbers like π and e?



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;








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


      1






      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 Apr 7 at 16:55







      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 Apr 7 at 16:44









      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 Apr 7 at 18:56

























                answered Apr 7 at 18:46









                LL3LL3

                1,2099




                1,2099




















                    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

                    getting Checkpoint VPN SSL Network Extender working in the command lineHow to connect to CheckPoint VPN on Ubuntu 18.04LTS?Will the Linux ( red-hat ) Open VPNC Client connect to checkpoint or nortel VPN gateways?VPN client for linux machine + support checkpoint gatewayVPN SSL Network Extender in FirefoxLinux Checkpoint SNX tool configuration issuesCheck Point - Connect under Linux - snx + OTPSNX VPN Ububuntu 18.XXUsing Checkpoint VPN SSL Network Extender CLI with certificateVPN with network manager (nm-applet) is not workingWill the Linux ( red-hat ) Open VPNC Client connect to checkpoint or nortel VPN gateways?VPN client for linux machine + support checkpoint gatewayImport VPN config files to NetworkManager from command lineTrouble connecting to VPN using network-manager, while command line worksStart a VPN connection with PPTP protocol on command linestarting a docker service daemon breaks the vpn networkCan't connect to vpn with Network-managerVPN SSL Network Extender in FirefoxUsing Checkpoint VPN SSL Network Extender CLI with certificate

                    Cannot Extend partition with GParted The 2019 Stack Overflow Developer Survey Results Are In Announcing the arrival of Valued Associate #679: Cesar Manara Planned maintenance scheduled April 17/18, 2019 at 00:00UTC (8:00pm US/Eastern) 2019 Community Moderator Election ResultsCan't increase partition size with GParted?GParted doesn't recognize the unallocated space after my current partitionWhat is the best way to add unallocated space located before to Ubuntu 12.04 partition with GParted live?I can't figure out how to extend my Arch home partition into free spaceGparted Linux Mint 18.1 issueTrying to extend but swap partition is showing as Unknown in Gparted, shows proper from fdiskRearrange partitions in gparted to extend a partitionUnable to extend partition even though unallocated space is next to it using GPartedAllocate free space to root partitiongparted: how to merge unallocated space with a partition

                    Marilyn Monroe Ny fiainany manokana | Jereo koa | Meny fitetezanafanitarana azy.