From e47c8502bf484c440a2b430a24ef52dd07f74400 Mon Sep 17 00:00:00 2001 From: Steven Nguyen Date: Thu, 22 May 2025 16:58:01 -0700 Subject: [PATCH] docs: add guidance on placeholders --- STYLE.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/STYLE.md b/STYLE.md index acf9a03c1..782307d79 100644 --- a/STYLE.md +++ b/STYLE.md @@ -332,6 +332,13 @@ or a page needs to be sufficiently different from existing pages, follow exisitn If you are proposing a new type of page, discuss an outline in your PR and ask for the Appwrite team's review. +### Placeholders + +Whenever there's a need for a placeholder such as for an ID, use angle brackets (<>) over square brackets ([]) because square brackets can be confused for an array. + +- ✅ `client.setEndpoint("https://.cloud.appwrite.io")` +- ❌ `client.setEndpoint("https://[REGION].cloud.appwrite.io")` + ## Code snippets For quick starts and tutorials, a developer must be able to follow code examples from beginning to end