Skip to content

Commit 2dba05e

Browse files
authored
feat: Remove def list syntax (#11238)
1 parent 3cd6490 commit 2dba05e

File tree

5 files changed

+53
-53
lines changed

5 files changed

+53
-53
lines changed

develop-docs/sdk/envelopes.mdx

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -119,19 +119,19 @@ Envelopes can have a number of headers which are valid in all situations:
119119

120120
`dsn`
121121

122-
: *String, recommended.* An envelope can be self authenticated. This means that
122+
**String, recommended.** An envelope can be self authenticated. This means that
123123
the envelope has all the information necessary to be sent to sentry. In this
124124
case the full DSN must be stored in this key.
125125

126126
`sdk`
127127

128-
: *Object, recommended.* This can carry the same payload as the <Link to="/sdk/event-payloads/sdk/">`sdk` interface</Link>
128+
**Object, recommended.** This can carry the same payload as the <Link to="/sdk/event-payloads/sdk/">`sdk` interface</Link>
129129
in the event payload but can be carried for all events. This means that SDK
130130
information can be carried for minidumps, session data and other submissions.
131131

132132
`sent_at`
133133

134-
: *String, recommended.* The timestamp when the event was sent from the SDK as string in
134+
**String, recommended.** The timestamp when the event was sent from the SDK as string in
135135
[RFC 3339](https://tools.ietf.org/html/rfc3339) format. Used for clock drift
136136
correction of the event timestamp. The time zone must be UTC.
137137

@@ -153,22 +153,22 @@ The timestamp can be generated by any of the following (for example):
153153

154154
JavaScript
155155

156-
: `new Date().toISOString()`
156+
`new Date().toISOString()`
157157

158158
Python
159159

160-
: `datetime.now(timezone.utc).isoformat()`<br />
160+
`datetime.now(timezone.utc).isoformat()`<br />
161161
*Don't use `datetime.utcnow()`, as it will omit the time zone.*
162162

163163
.NET
164164

165-
: `DateTime.UtcNow.ToString("o", CultureInfo.InvariantCulture)`
165+
`DateTime.UtcNow.ToString("o", CultureInfo.InvariantCulture)`
166166
or
167167
`DateTimeOffset.UtcNow.ToString("o", CultureInfo.InvariantCulture)`
168168

169169
Java
170170

171-
: `Instant.now().toString()`
171+
`Instant.now().toString()`
172172

173173
*Also note that the `sent_at` header replaces the `sentry_timestamp` key previously set in authorization headers,
174174
which has now been fully deprecated. You should only send `sent_at`, and not `sentry_timestamp`.*
@@ -190,7 +190,7 @@ There are two generic headers for every Item:
190190

191191
`length`
192192

193-
: *int, recommended.* The length of the payload in bytes. If no `length` is
193+
**int, recommended.** The length of the payload in bytes. If no `length` is
194194
specified, the payload implicitly goes to the next newline. For payloads
195195
containing newline characters, the `length` must be specified.
196196

@@ -390,7 +390,7 @@ file. It is always associated to an event or transaction.
390390

391391
`attachment_type`
392392

393-
: *String, optional.* The special type of this attachment. Possible values are:
393+
**String, optional.** The special type of this attachment. Possible values are:
394394

395395
- **`event.attachment` (default)**: A standard attachment without special
396396
meaning.
@@ -406,7 +406,7 @@ file. It is always associated to an event or transaction.
406406

407407
`content_type`
408408

409-
: *String, optional.* The content type of the attachment payload. Any [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) may be used; the default is `application/octet-stream`.
409+
**String, optional.** The content type of the attachment payload. Any [MIME type](https://www.iana.org/assignments/media-types/media-types.xhtml) may be used; the default is `application/octet-stream`.
410410

411411
### Session
412412

@@ -491,15 +491,15 @@ The item contains a user feedback / user report JSON payload:
491491

492492
`email`
493493

494-
: *String, recommended.* The email of the user.
494+
**String, recommended.** The email of the user.
495495

496496
`name`
497497

498-
: *String, recommended.* The name of the user.
498+
**String, recommended.** The name of the user.
499499

500500
`comments`
501501

502-
: *String, recommended.* Comments of the user about what happened.
502+
**String, recommended.** Comments of the user about what happened.
503503

504504
**Constraints:**
505505

@@ -577,7 +577,7 @@ details.
577577

578578
`length`
579579

580-
: **integer, required.** The size of the Replay recording payload
580+
**integer, required.** The size of the Replay recording payload
581581

582582
### Profile
583583

develop-docs/sdk/event-payloads/contexts.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -396,7 +396,7 @@ _Optional_. A list of visible UI screens at the current point in time.
396396

397397
`start_type`
398398

399-
: _Optional_. The way the OS started the app. For example, `cold`, `warm`, `cold.prewarmed`, or `warm.prewarmed`.
399+
_Optional_. The way the OS started the app. For example, `cold`, `warm`, `cold.prewarmed`, or `warm.prewarmed`.
400400

401401
## Browser Context
402402

@@ -824,13 +824,13 @@ The required field is `package` which should contain the package or framework wh
824824

825825
`package`
826826

827-
: **Required.** The package or framework where a missing instrumentation was detected.
827+
**Required.** The package or framework where a missing instrumentation was detected.
828828

829829
- Example: `express`
830830

831831
`javascript.is_cjs`
832832

833-
: _Optional_. Boolean that indicates if the context was added from a commonjs module.
833+
_Optional_. Boolean that indicates if the context was added from a commonjs module.
834834

835835
- Example: `true`
836836

develop-docs/sdk/event-payloads/replay-recording.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The recording event is an object with the following required properties:
88

99
`type`
1010

11-
: **EventTypeEnum** The `type` describes what type of event it is. See the enum below.
11+
**EventTypeEnum** The `type` describes what type of event it is. See the enum below.
1212

1313
```
1414
EventTypeEnum {
@@ -24,23 +24,23 @@ EventTypeEnum {
2424

2525
`timestamp`
2626

27-
: **float** The timestamp (in milliseconds) at which the event occurs
27+
**float** The timestamp (in milliseconds) at which the event occurs
2828

2929
`data`
3030

31-
: **unknown** `data` schema is dependent on the `type`. View the [base types](https://github.com/rrweb-io/rrweb/blob/master/packages/types/src/index.ts) or Sentry's [custom types](https://github.com/getsentry/sentry-javascript/blob/master/packages/replay-internal/src/types/replayFrame.ts).
31+
**unknown** `data` schema is dependent on the `type`. View the [base types](https://github.com/rrweb-io/rrweb/blob/master/packages/types/src/index.ts) or Sentry's [custom types](https://github.com/getsentry/sentry-javascript/blob/master/packages/replay-internal/src/types/replayFrame.ts).
3232

3333
## Custom Events
3434

3535
Sentry custom events augment the replay with additional context in order to help the user debug issues. Custom events have the following format for the `data` property of the event:
3636

3737
`tag`
3838

39-
: **string** The tag is used to describe the "type" of custom event. This will determine how the event gets used in the UI.
39+
**string** The tag is used to describe the "type" of custom event. This will determine how the event gets used in the UI.
4040

4141
`payload`
4242

43-
: **object** The `payload` is similar to the upper level `data` attribute, whose schema is dependent on the `tag`.
43+
**object** The `payload` is similar to the upper level `data` attribute, whose schema is dependent on the `tag`.
4444

4545
In addition to the TypeScript references linked above, the following sections will describe the expected `payload` for custom events.
4646

develop-docs/sdk/telemetry/profiles/sample-format-v1.mdx

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -82,13 +82,13 @@ in the same envelope as the associated transaction.
8282

8383
`debug_meta`
8484

85-
: *Object, required on native platforms.* This carries the same payload as the <Link
85+
*Object, required on native platforms.* This carries the same payload as the <Link
8686
to="/sdk/event-payloads/sdk/">`debug_meta` interface</Link>. It is required to
8787
have it for native platforms in order to symbolicate. For non-native platforms, you can omit this.
8888

8989
`device`
9090

91-
: *Object, required.* This contains several fields that describe the device the
91+
*Object, required.* This contains several fields that describe the device the
9292
profiler is running on.
9393

9494
It can have the following attributes:
@@ -112,17 +112,17 @@ It can have the following attributes:
112112

113113
`environment`
114114

115-
: *String, recommended.* The environment name, such as `production` or
115+
*String, recommended.* The environment name, such as `production` or
116116
`staging`. The default value is `production`.
117117

118118
`event_id`
119119

120-
: *String, required.* Hexadecimal string representing a uuid4 value. The length
120+
*String, required.* Hexadecimal string representing a uuid4 value. The length
121121
must be exactly 32 characters. Dashes and uppercase letters are not allowed.
122122

123123
`measurements`
124124

125-
: *Object, optional.* This field contains various metrics measured during the profile collection.
125+
*Object, optional.* This field contains various metrics measured during the profile collection.
126126

127127
A measurement is a collection of measurement values and a unit for those values.
128128
It will only be shown in the UI if it's been integrated. Right now, we only
@@ -158,7 +158,7 @@ These are the values accepted for `unit`:
158158

159159
`os`
160160

161-
: *Object, required.* Contains information about the OS.
161+
*Object, required.* Contains information about the OS.
162162

163163

164164
It can have the following attributes:
@@ -178,7 +178,7 @@ It can have the following attributes:
178178

179179
`platform`
180180

181-
: *String, required.* This value represents the platform the SDK is submitting
181+
*String, required.* This value represents the platform the SDK is submitting
182182
from.
183183

184184
Acceptable values are:
@@ -189,20 +189,20 @@ Acceptable values are:
189189

190190
`profile`
191191

192-
: *Object, required.* It contains all the raw data collected when profiling. See
192+
*Object, required.* It contains all the raw data collected when profiling. See
193193
[profile data](#profile-data).
194194

195195
`release`
196196

197-
: *String, required.* The release version of the application.
197+
*String, required.* The release version of the application.
198198

199199
**Release versions must be unique across all projects in your organization**.
200200
This value can be the git SHA for the given project, or a product identifier
201201
with a semantic version (suggested format `[email protected]`).
202202

203203
`runtime`
204204

205-
: *Object, optional.* Contains information about the runtime. Usually only used
205+
*Object, optional.* Contains information about the runtime. Usually only used
206206
for platforms allowing several runtimes.
207207

208208
It can have the following attributes:
@@ -220,7 +220,7 @@ It can have the following attributes:
220220

221221
`timestamp`
222222

223-
: *String, recommended.* The timestamp when the profile was captured by the SDK
223+
*String, recommended.* The timestamp when the profile was captured by the SDK
224224
as [RFC 3339](https://tools.ietf.org/html/rfc3339) format. This is meant to be
225225
the anchor for all relative timestamps captured for the profile.
226226

@@ -235,7 +235,7 @@ later on.
235235

236236
`transaction`
237237

238-
: *Object, required.* Contains information about the transaction it is
238+
*Object, required.* Contains information about the transaction it is
239239
associated with.
240240

241241
It can have the following attributes:
@@ -249,7 +249,7 @@ It can have the following attributes:
249249

250250
`version`
251251

252-
: *String, required.* Represents the version of the Sample format.
252+
*String, required.* Represents the version of the Sample format.
253253

254254
Acceptable values are:
255255
- `"1"`
@@ -304,7 +304,7 @@ milliseconds.
304304

305305
`samples`
306306

307-
: *List, required* Contains a list of sample object captured during execution.
307+
*List, required* Contains a list of sample object captured during execution.
308308
Each sample can contain the following attributes:
309309

310310
- `elapsed_since_start_ns`: *String, required.* Contains the relative timestamp
@@ -324,7 +324,7 @@ Each sample can contain the following attributes:
324324

325325
`stacks`
326326

327-
: *List, required*. Contains a list of frame indices forming a stack trace.
327+
*List, required*. Contains a list of frame indices forming a stack trace.
328328

329329
Frames in a stack should be ordered from leaf to root. It means your main frame
330330
should be at the end of the list.
@@ -334,7 +334,7 @@ the same `stack_id` for each sample that needs it.
334334

335335
`frames`
336336

337-
: *List, required*. Contains a list of frame objects (see [Frame
337+
*List, required*. Contains a list of frame objects (see [Frame
338338
Attributes](/sdk/event-payloads/stacktrace/#frame-attributes)).
339339

340340
Each object should contain at least a `filename`, `function` or
@@ -359,7 +359,7 @@ Some attributes are not used at the moment:
359359

360360
`thread_metadata`
361361

362-
: *Object, required.* Contains an object with a field for each thread ID
362+
*Object, required.* Contains an object with a field for each thread ID
363363
detected during runtime.
364364

365365
This object can contain these attributes:

0 commit comments

Comments
 (0)