• mashbooq@infosec.pub
    link
    fedilink
    arrow-up
    14
    ·
    1 year ago

    Also me when I’m forced to write documentation for a Python function

    def delete_first_of_list(the_list: list):
    
    • RagingRobot@lemmy.world
      link
      fedilink
      arrow-up
      5
      ·
      1 year ago

      Does this return a new list or modify the original? I would hope it returns a new one but I would know for sure if there was documentation.

      • kablammy@sh.itjust.works
        link
        fedilink
        arrow-up
        4
        ·
        1 year ago

        I would hope it modifies the original. It’s implied in the name. A function that returns all but the first item should be named something like tail or without_first_item.

      • coloredgrayscale
        link
        fedilink
        arrow-up
        3
        ·
        1 year ago

        If they need it often it makes some sense, if it also perform some checks, if the list if empty or None/null.