Improve documentation of crypto_core_directory

Signed-off-by: Thomas Daubney <thomas.daubney@arm.com>
This commit is contained in:
Thomas Daubney 2023-11-30 13:59:30 +00:00
parent 08c6dc4942
commit 46588de8fc

View file

@ -23,7 +23,10 @@ def looks_like_root(path: str) -> bool:
return looks_like_tf_psa_crypto_root(path) or looks_like_mbedtls_root(path)
def crypto_core_directory(root: Optional[str] = None) -> str:
"""Return the path of the library code for either TF-PSA-Crypto or Mbed TLS."""
"""
Return the path of the directory containing the PSA crypto core
for either TF-PSA-Crypto or Mbed TLS.
"""
if root is None:
root = guess_project_root()
if looks_like_tf_psa_crypto_root(root):