Add documentation to the sized identity matrix

[ro-ble]

As proposed on discourse, I would like to add this to improve the documentation.

[andreasnoack]

Looks like Documenter doesn't understand this. @fredrikekre do you know if there is a way to do this?

[ro-ble]

The function seems to have documentation strings. However I believe that documenter struggles with the function declaration in the index.md file. From my still small Julia knowledge, I would guess, that it is something like this: https://docs.julialang.org/en/v1/manual/methods/#Function-like-objects-1
I believe functions like this have already been documented. I will search for one

[fredrikekre]

I don't think it is possible to include this in @docs-blocks, not sure though. @mortenpi?

[mortenpi]

Yeah, this is currently problematic. The docsystem is a bit buggy, but also Documenter probably can't handle it properly: JuliaDocs/Documenter.jl#558

Although, if it would work, I think the syntax for this in at-docs blocks should be

(::LinearAlgebra.UniformScaling)(::Integer)

[ro-ble]

I tried to replicate the behaviour of Documenter in REPL. Following things happened:

@doc (::UniformScaling)(::Integer) -> returns the correct documentation

(Edit:) @doc (::LinearAlgebra.UniformScaling)(::Integer) -> works also as expected when the library is imported instead of used. I wonder why the tests failed.

I am not shure how to proceed...

[mortenpi]

Since it's broken from the docsystem side, I would suggest merging the docstring for (I::UniformScaling)(n::Integer) into the docstring of struct UniformScaling and maybe also add a usage example of I(n) into the docstring of const I.

[ro-ble]

I would suggest merging the docstring for (I::UniformScaling)(n::Integer) into the docstring of struct UniformScaling and maybe also add a usage example of I(n) into the docstring of const I.

Yeah that would certainly be a valid solution. But before I do this, I will try to resolve this issue. According to zekeriya.sari's answer, I do believe that It should be possible.