search

nmdl-mizo / interface_master

A python package building CSL or approximate CSL interfaces of any two lattices and computing cell of non-identical displacement (CNID).
MIT License
12 stars 4 forks source link

Request for docstring modification #19

Open Na-Kawa opened 1 year ago

Na-Kawa commented 1 year ago

In the function "interfacemaster.interface_generator.core.parse_limit", the description for the parameters "see the paper" is not useful and I cannot understand clearly even though see the paper. Please write appropriate description about the parameter.

Na-Kawa commented 1 year ago

In the function "interfacemaster.interface_generator.core.search_one_position_2D", the description of the parameter does not match the actual parameter. Please modify.

kiyou commented 1 year ago

"interfacemaster.symmetric_tilt.compute_sigma()" has the same issue above.

kiyou commented 1 year ago

"interfacemaster.interface_generator.terminates_scanner_slab_structure()" has no docstring.

kiyou commented 1 year ago

In the function "interfacemaster.interface_generator.core.search_fixed()", the description of the parameter does not match the actual parameter.