Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix formatting on modal shell docs #2757

Merged
merged 5 commits into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion modal/cli/launch.py
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
name="launch",
no_args_is_help=True,
help="""
[Preview] Open a serverless app instance on Modal.
Open a serverless app instance on Modal.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we still consider these interfaces fairly unstable fwiw (but can remove the [Preview] from the top-level description.


This command is in preview and may change in the future.
""",
Expand Down
20 changes: 10 additions & 10 deletions modal/cli/run.py
Original file line number Diff line number Diff line change
Expand Up @@ -409,36 +409,36 @@ def shell(
):
"""Run a command or interactive shell inside a Modal container.

\b**Examples:**
**Examples:**

\bStart an interactive shell inside the default Debian-based image:
Start an interactive shell inside the default Debian-based image:

\b```
```
modal shell
```

\bStart an interactive shell with the spec for `my_function` in your App
Start an interactive shell with the spec for `my_function` in your App
(uses the same image, volumes, mounts, etc.):

\b```
```
modal shell hello_world.py::my_function
```

\bOr, if you're using a [modal.Cls](/docs/reference/modal.Cls), you can refer to a `@modal.method` directly:
Or, if you're using a [modal.Cls](/docs/reference/modal.Cls), you can refer to a `@modal.method` directly:

\b```
```
modal shell hello_world.py::MyClass.my_method
```

Start a `python` shell:

\b```
```
modal shell hello_world.py --cmd=python
```

\bRun a command with your function's spec and pipe the output to a file:
Run a command with your function's spec and pipe the output to a file:

\b```
```
modal shell hello_world.py -c 'uv pip list' > env.txt
```
"""
Expand Down
Loading