search

hpsc-lab / SecureArithmetic.jl

Secure arithmetic operations using fully homomorphic encryption
https://hpsc-lab.github.io/SecureArithmetic.jl
MIT License
7 stars 1 forks source link

Add docstrings and expand documentation #10

Closed sloede closed 7 months ago

sloede commented 10 months ago

Document the basic types such as SecureVector or PlainVector, including their constructors, and how to use them. Also document auxiliary functions such as level, capacity etc.

sloede commented 9 months ago

@ArseniyKholod it would be great if you could also have a look at this issue over the next few weeks. There is not as much to do as in https://github.com/sloede/OpenFHE.jl/issues/24.

ArseniyKholod commented 9 months ago

Document the basic types such as SecureVector or PlainVector, including their constructors, and how to use them. Also document auxiliary functions such as level, capacity etc.

Do I understand correctly that constructors needs to be documented together with corresponding structures inside the same """ doc """ ? I mean, they have the same names, cross referencing would be problematic...

sloede commented 9 months ago

Good question. I don't think so - if they are separate symbols, you can assign a docstring to each, but crossreferncing will not work, agreed.