Can you add this function to the module-level doc-string and add a `Parameters`, `Returns` and `Examples` section?