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

doc argument specification #2

Open
gingermusketeer opened this issue Mar 5, 2013 · 1 comment
Open

doc argument specification #2

gingermusketeer opened this issue Mar 5, 2013 · 1 comment

Comments

@gingermusketeer
Copy link
Owner

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.

@gingermusketeer
Copy link
Owner Author

the property signatures has been added to braceDoc to handle more complex parameter cases. Whilst it can handle the case described above it is very verbose ( 4 signatures are required).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant