Skip to content

Commit

Permalink
Documentation improvements (typos, grammar etc) (#1617)
Browse files Browse the repository at this point in the history
* fix envd/api/v0/__init__.py

* fix envd/api/v1/__init__.py

* fix install.py and runtime.py
  • Loading branch information
tddschn authored May 23, 2023
1 parent ef72477 commit 7500fa2
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions envd/api/v0/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ def base(os: str, language: str, image: Optional[str]):
Args:
os (str): The operating system (i.e. `ubuntu20.04`)
language (str): The programing language dependency (i.e. `python3.8`)
language (str): The programming language dependency (i.e. `python3.8`)
image (Optional[str]): Custom image (i.e. `python:3.9-slim`)
"""

Expand Down Expand Up @@ -80,7 +80,7 @@ def include(git: str):
"""Import from another git repo
This will pull the git repo and execute all the `envd` files. The return value will be a module
contains all the variables/functions defined (expect those has `_` prefix).
contains all the variables/functions defined (except the ones with `_` prefix).
Args:
git (str): git URL
Expand Down
2 changes: 1 addition & 1 deletion envd/api/v0/install.py
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@


def apt_packages(name: List[str]):
"""Install package by system-level package manager (apt on Ubuntu)
"""Install package using the system package manager (apt on Ubuntu)
Args:
name (List[str]): apt package name list
Expand Down
2 changes: 1 addition & 1 deletion envd/api/v0/runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ def daemon(commands: List[List[str]]):
"""Run daemon processes in the container
Proposal: https://github.com/tensorchord/envd/pull/769
It's better to redirect the logs to local files for debug purposes.
It's better to redirect the logs to local files for debugging purposes.
You can find the generated horust config files under `/etc/horust/services`
and log files under `/var/log/horust` in the container.
Expand Down
4 changes: 2 additions & 2 deletions envd/api/v1/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ def base(image: str = "ubuntu:20.04", dev: bool = False):
"""Set up the base env.
Args:
image (str): docker image, can be any Debian-based images
image (str): docker image, can be any Debian-based image
dev (bool): enabling the dev env will add lots of development related libraries like
envd-sshd, vim, git, shell prompt, vscode extensions, etc.
"""
Expand Down Expand Up @@ -89,7 +89,7 @@ def include(git: str):
"""Import from another git repo
This will pull the git repo and execute all the `envd` files. The return value will be a module
contains all the variables/functions defined (expect those has `_` prefix).
contains all the variables/functions defined (except the ones with `_` prefix).
Args:
git (str): git URL
Expand Down
2 changes: 1 addition & 1 deletion envd/api/v1/install.py
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ def julia():


def apt_packages(name: List[str] = []):
"""Install package by system-level package manager (apt on Ubuntu).
"""Install package using the system package manager (apt on Ubuntu).
Args:
name (List[str]): apt package name list
Expand Down
2 changes: 1 addition & 1 deletion envd/api/v1/runtime.py
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ def daemon(commands: List[List[str]]):
"""Run daemon processes in the container
Proposal: https://github.com/tensorchord/envd/pull/769
It's better to redirect the logs to local files for debug purposes.
It's better to redirect the logs to local files for debugging purposes.
You can find the generated horust config files under `/etc/horust/services`
and log files under `/var/log/horust` in the container.
Expand Down

0 comments on commit 7500fa2

Please sign in to comment.