Giving an Overview of a Function

A good function overview imparts understanding to a reader of what the function does and anything else a reader needs to know to successfully use a function. We use the term “overview” here to exclude more detailed documentation on parameters, return values, etc. (those are important and will come later) - “overview” as used here is intended to provide a higher-level summary/description before getting into finer-grained details.

Depending on a given function, there may be several important parts of a function overview: