Skip to content
This repository was archived by the owner on Aug 3, 2021. It is now read-only.
This repository was archived by the owner on Aug 3, 2021. It is now read-only.

doc argument specification #2

@gingermusketeer

Description

@gingermusketeer

The current documentation format for arguments does not satisfactorily cover the case found with string replace function. See https://developer.mozilla.org/en-US/docs/JavaScript/Reference/Global_Objects/String/replace

function somefunc(arg1 | altArg1, arg2 | altArg2){}

The type of the argument changes the behaviour of the function. Whilst this can be achieved with multiple signatures four signatures would be required which is unsatisfactory.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions