Skip to content

Commit 3c3b374

Browse files
committed
feedback
1 parent a9f83e7 commit 3c3b374

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/contributing/pages/components.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -382,15 +382,19 @@ If you're writing product feature specific docs, you can specify markers within
382382

383383
````markdown
384384
```go
385-
// ___product_option_start___ performance
385+
// ___PRODUCT_OPTION_START___ performance
386386
// your code here
387-
// ___product_option_end___ performance
387+
// ___PRODUCT_OPTION_END___ performance
388388
```
389389
````
390390

391-
the general syntax is `// ___product_option_start___ feature` where `feature` is the feature id (e.g. `performance`, `profiling` or `session-replay`).
391+
the syntax uses the standard comment style of the programming language you're documenting. For example:
392+
393+
- TypeScript/JavaScript: `// ___PRODUCT_OPTION_START___ feature`
394+
- Python: `# ___PRODUCT_OPTION_START___ feature`
395+
396+
where `feature` is the feature id (e.g. `performance`, `profiling` or `session-replay`).
392397

393-
You can specify multiple features by separating them with a comma:
394398

395399
The range visibility will be controlled by the `OnboardingOptionButtons` component:
396400

@@ -439,13 +443,13 @@ import (
439443
// To initialize Sentry's handler, you need to initialize Sentry itself beforehand
440444
if err := sentry.Init(sentry.ClientOptions{
441445
Dsn: "___PUBLIC_DSN___",
442-
// ___product_option_start___ performance
446+
// ___PRODUCT_OPTION_START___ performance
443447
EnableTracing: true,
444448
// Set TracesSampleRate to 1.0 to capture 100%
445449
// of transactions for performance monitoring.
446450
// We recommend adjusting this value in production,
447451
TracesSampleRate: 1.0,
448-
// ___product_option_end___ performance
452+
// ___PRODUCT_OPTION_END___ performance
449453
// Adds request headers and IP for users,
450454
// visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info
451455
SendDefaultPII: true,

0 commit comments

Comments
 (0)