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.

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

Add type hints to functions in python scripts #21

Closed
4 tasks
hechth opened this issue Nov 14, 2023 · 0 comments · Fixed by #31
Closed
4 tasks

Add type hints to functions in python scripts #21

hechth opened this issue Nov 14, 2023 · 0 comments · Fixed by #31
Assignees

Comments

@hechth
Copy link
Member

hechth commented Nov 14, 2023

Type hints in python serve as a hint to the integrated development environment (IDE) which type a function parameter or variable can have and makes it then easier for developers to figure out how this variable can be used. Functions should also receive return type annotations to indicate what is actually returned by the function.

Detailed description of type hints in python and how they can be validated is available here.

Files in which to add functions:

  • analysis/Python_scripts/utils.py
  • analysis/Python_scripts/plotting.py
  • codes/extract_coords_into_inp_xyz.py
  • codes/write_dirs_files_for_gamess_qcxms.py
@hechth hechth changed the title Add type hints to functions Add type hints to functions in python scripts Nov 14, 2023
@hechth hechth assigned wverastegui and unassigned wverastegui Feb 8, 2024
@wverastegui wverastegui self-assigned this Feb 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants