Skip to content

Commit e47c850

Browse files
committed
docs: add guidance on placeholders
1 parent 7d16836 commit e47c850

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

STYLE.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -332,6 +332,13 @@ or a page needs to be sufficiently different from existing pages, follow exisitn
332332

333333
If you are proposing a new type of page, discuss an outline in your PR and ask for the Appwrite team's review.
334334

335+
### Placeholders
336+
337+
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.
338+
339+
-`client.setEndpoint("https://<REGION>.cloud.appwrite.io")`
340+
-`client.setEndpoint("https://[REGION].cloud.appwrite.io")`
341+
335342
## Code snippets
336343

337344
For quick starts and tutorials, a developer must be able to follow code examples from beginning to end

0 commit comments

Comments
 (0)