Skip to content

Commit

Permalink
docs: fix bullet formatting for kubernetes pod executor
Browse files Browse the repository at this point in the history
While the bullets are rendered correctly in GitHub when looking at this
file, the bullet formatting is incorrect on the actual documentation
site [[1]]. This patch adds a newline to fix that formatting.

A screenshot of the incorrect formatting on the site is included in
the PR.

[1]: https://microsoft.github.io/autogen/0.2/docs/topics/code-execution/kubernetes-pod-commandline-code-executor
  • Loading branch information
lukehsiao committed Oct 23, 2024
1 parent 6103889 commit ff02319
Showing 1 changed file with 2 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
"It functions similarly to the `DockerCommandLineCodeExecutor`, but specifically creates container within Kubernetes environments.\n",
"\n",
"There are two condition to use PodCommandLineCodeExecutor.\n",
"\n",
"- Access to a Kubernetes cluster\n",
"- installation `autogen` with the extra requirements `'pyautogen[kubernetes]'`\n",
"\n",
Expand All @@ -38,6 +39,7 @@
"metadata": {},
"source": [
"There are four options PodCommandLineCodeExecutor to access kubernetes API server.\n",
"\n",
"- default kubeconfig file path: `~/.kube/config`\n",
"- Provide a custom kubeconfig file path using the `kube_config_file` argument of `PodCommandLineCodeExecutor`.\n",
"- Set the kubeconfig file path using the `KUBECONFIG` environment variable.\n",
Expand Down

0 comments on commit ff02319

Please sign in to comment.