`reflectorch.data_generation.reflectivity.abeles.abeles` docstring is incomplete

schreiber-lab / reflectorch

Machine learning package for X-ray and neutron reflectometry incorporating prior knowledge

https://www.soft-matter.uni-tuebingen.de/

MIT License

1 stars 0 forks source link

`reflectorch.data_generation.reflectivity.abeles.abeles` docstring is incomplete #12

Open andyfaff opened 1 month ago

andyfaff commented 1 month ago

I've been experimenting using the reflectorch implementation of the abeles calculation, using reflectorch.data_generation.reflectivity.abeles.abeles.

The docstring for the implementation does not specify:

what the shapes of q, thickness, roughness, sld should be.
whether sld can be complex or real.
what the output shape will be.

StarostinV commented 1 month ago

Thanks! Partially fixed in a1d0da6 and will be updated according to #13