Docs: function parameters

[AndreKR]

The docs builder simplifies the headings here:

sharp/docs/build.js

Line 32 in 9563568

.replace(/(## [A-Za-z0-9]+)[^\n]*/g, '$1') // simplify headings to match those of documentationjs, ensures existing URLs work

I'm assuming this is because you previously used documentation.js and wanted to keep the anchors the same.

The issue with that is that it's not really clear that for example in the following screenshot [angle] and [options] are the first and the second parameter of rotate():

Took me a while to understand that I'm not supposed to pass an object with angle and options keys.

I took a look at how documentation.js deals with this and while it's also not great IMO, the indentation does make it more clear:

Anyway, maybe you could add the full method signature as a code block right below the header? That would be easily doable just by extending the regex replace.

[lovell]

Thanks for reporting this, commit 67e927b ensures method signatures are included below headings.