Also me when I'm forced to write documentation for a Python function
def delete_first_of_list(the_list: list):
What if I pass an empty list, or NoneType?
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.
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.
This is a good way to realise that you don't need a function for that use case.
If they need it often it makes some sense, if it also perform some checks, if the list if empty or None/null.
Also me when I'm forced to write documentation for a Python function
What if I pass an empty list, or NoneType?
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.
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
tailorwithout_first_item.This is a good way to realise that you don't need a function for that use case.
If they need it often it makes some sense, if it also perform some checks, if the list if empty or None/null.