firmware_checks._01_check_tcmd_structs_and_docs Namespace Reference

Functions
None	check_tcmd_struct_fields ()
None	check_tcmd_arg_lists ()
None	check_tcmd_function_names_match_registration_names ()

Variables
	GIT_REPO_ROOT_PATH = Path(git.Repo(__file__, search_parent_directories=True).working_tree_dir)

Detailed Description

Check that the telecommand definitions are good.

Function Documentation

check_tcmd_arg_lists()

None firmware_checks._01_check_tcmd_structs_and_docs.check_tcmd_arg_lists

(

)

Check that the telecommand docstrings have the correct number of arguments.

Here is the caller graph for this function:

check_tcmd_function_names_match_registration_names()

None firmware_checks._01_check_tcmd_structs_and_docs.check_tcmd_function_names_match_registration_names

(

)

Check that the telecommand function names match the registration names.

Here is the call graph for this function:

Here is the caller graph for this function:

check_tcmd_struct_fields()

None firmware_checks._01_check_tcmd_structs_and_docs.check_tcmd_struct_fields

(

)

Check that the telecommand struct fields are all present.

Here is the caller graph for this function:

Variable Documentation

GIT_REPO_ROOT_PATH

firmware_checks._01_check_tcmd_structs_and_docs.GIT_REPO_ROOT_PATH = Path(git.Repo(__file__, search_parent_directories=True).working_tree_dir)