Skip to content

Docs: function parameters #3777

Closed
Closed

Description

@AndreKR

The docs builder simplifies the headings here:

.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():

image

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:

image

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.

Activity

  1. lovell commented on Aug 29, 2023

    @lovell
    Owner

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions