We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
There was an error while loading. Please reload this page.
1 parent 75f6a9f commit 145417eCopy full SHA for 145417e
1 file changed
AGENTS.md
@@ -65,3 +65,18 @@ go mod tidy
65
- **CI Pipelines**:
66
- `Test`: Runs build checks via `go build`.
67
- `Lint`: Runs `gofmt` and `go vet`.
68
+
69
+## Code Snippets
70
71
+When writing samples that will be referenced in documentation, mark the regions using the following format:
72
73
+```go
74
+// [START unique_snippet_id]
75
+func Example() {
76
+ // ...
77
+}
78
+// [END unique_snippet_id]
79
+```
80
81
+- Ensure the ID is unique across the repository.
82
+- Do not indent the `// [START ...]` and `// [END ...]` tags.
0 commit comments