Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Multiple signatures in one docstring #19062

Closed
carlobaldassi opened this issue Oct 22, 2016 · 1 comment
Closed

Multiple signatures in one docstring #19062

carlobaldassi opened this issue Oct 22, 2016 · 1 comment
Labels
docsystem The documentation building system

Comments

@carlobaldassi
Copy link
Member

There's currently no way to associate multiple function signatures to the same docstring, when they cannot be expressed with Unions. Case in point: this, where I was hoping to be able to associate the same docstring to both these signatures:

BitArray(dims::Integer...) = BitArray(map(Int,dims))
BitArray{N}(dims::NTuple{N,Int}) = BitArray{N}(dims...)

(and I could not just remove the signature check because of a different definition/docstring used for the BitArray(iter) case.)

@ViralBShah
Copy link
Member

I believe there are a few ways to achieve this. See discussion in https://stackoverflow.com/questions/72024086/one-docstring-for-multiple-functions-in-julia. If necessary, please reopen.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docsystem The documentation building system
Projects
None yet
Development

No branches or pull requests

2 participants