Skip to content
This repository was archived by the owner on Aug 14, 2024. It is now read-only.

Commit 77dcd4d

Browse files
smeubankantonpirkeradinauer
authored
Unified API Disclaimer (#1193)
With the work on hubs and scopes refactoring, this page needs a disclaimer even more than before https://develop.sentry.dev/sdk/hub_and_scope_refactoring/ --------- Co-authored-by: Anton Pirker <anton.pirker@sentry.io> Co-authored-by: Alexander Dinauer <adinauer@users.noreply.github.com>
1 parent 71fd88c commit 77dcd4d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

src/docs/sdk/unified-api/index.mdx

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,20 @@
22
title: 'Unified API'
33
---
44

5+
<Alert title="Note" level="info">
6+
7+
Everything written here sounds real nice. However, we live in a practical world, and expect each platform to adhere to what makese sense for the developers there. What is written below is not to be taken as strict rules. It is a guide and to be thought of as a tool to help developers build SDKs which work well which eachother.
8+
9+
The top priority when building SDKs is a high quality API and developer experience, don’t let unified API be an excuse to build things which don't make sense for a given language.
10+
11+
*Types Example:* Typed languages might have very different developer experience than dynamic.
12+
13+
*Platform Example:* Does Rust have exceptions? Nope, don't name APIs for rust like `captureException`.
14+
15+
*Unified API Example:* We don't like Hubs and Scopes anymore, and we are redefining that, <Link to="/sdk/hub_and_scope_refactoring/">Hub & Scope Refactoring</Link>
16+
17+
</Alert>
18+
519
New Sentry SDKs should follow the unified API, use consistent terms to refer to concepts. This
620
documentation explains what the unified API is and why it exists.
721

0 commit comments

Comments
 (0)