Fixed docs (#674)

This commit is contained in:
UebelAndre 2021-06-13 11:21:29 -07:00 committed by GitHub
parent 2407938f22
commit a669422fa5
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 6 deletions

View File

@ -36,7 +36,7 @@ def create_cmake_script(
is_debug_mode: If the compilation mode is `debug`. Defaults to True.
Returns:
string: A formatted string of the generated build command
list: Lines of bash which make up the build script
"""
merged_prefix_path = _merge_prefix_path(user_cache, include_dirs)

View File

@ -1,9 +1,19 @@
# buildifier: disable=module-docstring
# buildifier: disable=function-docstring
"""A module for creating the build script for `make` builds"""
def create_make_script(
root,
inputs,
make_commands):
"""Constructs Make script to be passed to cc_external_rule_impl.
Args:
root (str): sources root relative to the $EXT_BUILD_ROOT
inputs (struct): An InputFiles provider
make_commands (list): Lines of bash which invoke make
Returns:
list: Lines of bash which make up the build script
"""
ext_build_dirs = inputs.ext_build_dirs
script = pkgconfig_script(ext_build_dirs)
@ -15,10 +25,15 @@ def create_make_script(
script.append("##disable_tracing##")
return script
# buildifier: disable=function-docstring-args
# buildifier: disable=function-docstring-return
def pkgconfig_script(ext_build_dirs):
"""Create a script fragment to configure pkg-config"""
"""Create a script fragment to configure pkg-config
Args:
ext_build_dirs (list): A list of directories (str)
Returns:
list: Lines of bash that perform the update of `pkg-config`
"""
script = []
if ext_build_dirs:
for ext_dir in ext_build_dirs: