Skip to content

Documentation does not specify that marimo run never sends the code to the client #9489

Description

@umnikos

Documentation is

  • Missing
  • Outdated
  • Confusing
  • Not sure?

Explain in Detail

The documentation for marimo run says that "the python code is hidden and uneditable" by default, but that does not imply that the code is never sent to the client.
Hypothetically what the sentence could mean is that the code is hidden by default and that the user can click a button to show it, or that the code is never shown but still sent and can be accessed through the dev tools.

The code truly never being sent is important for scenarios where the source code of the notebook is confidential information that shouldn't be leaked.

Relevant unit test:

async def test_kernel_ready_sends_names_but_not_code_when_include_code_false(

Your Suggestion for Changes

Add "and never sent to the client" in relevant places. At minimum it should be added to the description of the --include-code flag (https://docs.marimo.io/cli/#marimo-run) but ideally it will also be added to other relevant places (https://docs.marimo.io/guides/deploying/)

Will you submit a PR?

  • Yes

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions