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.

Sign up for GitHub

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

Jump to bottom

Request for docstring modification #19

Open
Na-Kawa opened this issue Feb 15, 2023 · 4 comments
Open

Request for docstring modification #19

Na-Kawa opened this issue Feb 15, 2023 · 4 comments
Assignees
@jinlhr542
Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers

Comments

@Na-Kawa
Copy link

Na-Kawa commented Feb 15, 2023

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
Copy link
Author

Na-Kawa commented Feb 15, 2023 •
edited
Loading

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 kiyou added documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers labels Feb 15, 2023
@kiyou
Copy link
Contributor

kiyou commented Feb 17, 2023

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

@kiyou
Copy link
Contributor

kiyou commented Feb 17, 2023

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

@kiyou
Copy link
Contributor

kiyou commented Feb 17, 2023

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jinlhr542 jinlhr542

Labels
documentation Improvements or additions to documentation enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@kiyou @jinlhr542 @Na-Kawa