diff --git a/docs/template/names.mdx b/docs/template/names.mdx index 2a7ddc03..54ae4b3d 100644 --- a/docs/template/names.mdx +++ b/docs/template/names.mdx @@ -38,6 +38,17 @@ sandbox = Sandbox.create('my-python-env') +## Name format + +Before a name is used, it's trimmed of surrounding whitespace and lowercased. The result must match the pattern `^[a-z0-9-_]+$`: + +- Lowercase letters (`a`–`z`), numbers (`0`–`9`), dashes (`-`), and underscores (`_`) +- At least one character +- Leading and trailing dashes or underscores are allowed +- No maximum length + +Uppercase letters are accepted on input and lowercased automatically, so `My-Template` and `my-template` refer to the same name. Any other character (spaces inside the name, dots, slashes, and so on) is rejected. + ## Team-local naming Template names are scoped to your team. This means: