Python docstring format with more than one input type












0















I am using Google-style python docstring format.
There's one function, and the input parameter could be dict, list, or string.
What is the format of multiple data type in docstring?



Like



Args:
input (str, list, dict): input of this function









share|improve this question



























    0















    I am using Google-style python docstring format.
    There's one function, and the input parameter could be dict, list, or string.
    What is the format of multiple data type in docstring?



    Like



    Args:
    input (str, list, dict): input of this function









    share|improve this question

























      0












      0








      0








      I am using Google-style python docstring format.
      There's one function, and the input parameter could be dict, list, or string.
      What is the format of multiple data type in docstring?



      Like



      Args:
      input (str, list, dict): input of this function









      share|improve this question














      I am using Google-style python docstring format.
      There's one function, and the input parameter could be dict, list, or string.
      What is the format of multiple data type in docstring?



      Like



      Args:
      input (str, list, dict): input of this function






      python docstring






      share|improve this question













      share|improve this question











      share|improve this question




      share|improve this question










      asked Nov 20 '18 at 8:44









      user19881219user19881219

      418




      418
























          1 Answer
          1






          active

          oldest

          votes


















          2














          As it is stated in the Sphinx 1.5 documentation describing this style of formatting, PEP 484 type annotations are supported.



          PEP 484 specifies the Union type as appropriate for a situation where you have a limited set of accepted types for an argument. In your example it will be:



          Args:
          input (Union[str, list, dict]): input of this function





          share|improve this answer

























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


            }
            });














            draft saved

            draft discarded


















            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53389169%2fpython-docstring-format-with-more-than-one-input-type%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









            2














            As it is stated in the Sphinx 1.5 documentation describing this style of formatting, PEP 484 type annotations are supported.



            PEP 484 specifies the Union type as appropriate for a situation where you have a limited set of accepted types for an argument. In your example it will be:



            Args:
            input (Union[str, list, dict]): input of this function





            share|improve this answer






























              2














              As it is stated in the Sphinx 1.5 documentation describing this style of formatting, PEP 484 type annotations are supported.



              PEP 484 specifies the Union type as appropriate for a situation where you have a limited set of accepted types for an argument. In your example it will be:



              Args:
              input (Union[str, list, dict]): input of this function





              share|improve this answer




























                2












                2








                2







                As it is stated in the Sphinx 1.5 documentation describing this style of formatting, PEP 484 type annotations are supported.



                PEP 484 specifies the Union type as appropriate for a situation where you have a limited set of accepted types for an argument. In your example it will be:



                Args:
                input (Union[str, list, dict]): input of this function





                share|improve this answer















                As it is stated in the Sphinx 1.5 documentation describing this style of formatting, PEP 484 type annotations are supported.



                PEP 484 specifies the Union type as appropriate for a situation where you have a limited set of accepted types for an argument. In your example it will be:



                Args:
                input (Union[str, list, dict]): input of this function






                share|improve this answer














                share|improve this answer



                share|improve this answer








                edited Dec 5 '18 at 17:10

























                answered Nov 20 '18 at 9:30









                arudzinskaarudzinska

                1,396618




                1,396618
































                    draft saved

                    draft discarded




















































                    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.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function () {
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53389169%2fpython-docstring-format-with-more-than-one-input-type%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

                    Guess what letter conforming each word

                    Port of Spain

                    Run scheduled task as local user group (not BUILTIN)