[Docs] Update docstrings (#780)

To add more color on the meaning of some arguments.
This commit is contained in:
William FH
2024-06-23 17:38:26 -07:00
committed by GitHub
parent 20f84f2041
commit d9b4d021bd
6 changed files with 178 additions and 70 deletions
+5 -4
View File
@@ -42,7 +42,7 @@ _MANUAL = {
"introduction.ipynb",
"customer-support/customer-support.ipynb",
"tutorials/tnt-llm/tnt-llm.ipynb",
"tutorials/sql-agent.ipynb"
"tutorials/sql-agent.ipynb",
],
}
_MANUAL_INVERSE = {v: docs_dir / k for k, vs in _MANUAL.items() for v in vs}
@@ -103,9 +103,9 @@ def copy_notebooks():
continue
if any(path in _HOW_TOS for path in root.split(os.sep)):
dst_dir = how_tos_dir
elif 'sdk' in root.split(os.sep):
elif "sdk" in root.split(os.sep):
dst_dir = cloud_sdk_dir
elif 'cloud_examples' in root.split(os.sep):
elif "cloud_examples" in root.split(os.sep):
dst_dir = cloud_how_tos_dir
else:
dst_dir = tutorials_dir
@@ -145,7 +145,7 @@ def copy_notebooks():
with open(dst_path, "w") as f:
f.write(content)
dst_dir = dst_dir_
# Top level notebooks are "how-to's"
# for file in examples_dir.iterdir():
# if file.suffix.endswith(".ipynb") and not os.path.isdir(
@@ -155,6 +155,7 @@ def copy_notebooks():
# dst_path = os.path.join(docs_dir, "how-tos", file.name)
# shutil.copy(src_path, dst_path)
if __name__ == "__main__":
clean_notebooks()
copy_notebooks()