Skip to content

Commit

Permalink
fix: typos in documentation (#697)
Browse files Browse the repository at this point in the history
  • Loading branch information
hougesen authored Oct 14, 2024
1 parent d0585b6 commit 2fe26e0
Show file tree
Hide file tree
Showing 7 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion sentry-core/src/hub_impl.rs
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@ impl Hub {
/// will return the provided hub.
///
/// Once the function is finished executing, including after it
/// paniced, the original hub is re-installed if one was present.
/// panicked, the original hub is re-installed if one was present.
pub fn run<F: FnOnce() -> R, R>(hub: Arc<Hub>, f: F) -> R {
let _guard = SwitchGuard::new(hub);
f()
Expand Down
2 changes: 1 addition & 1 deletion sentry-core/src/performance.rs
Original file line number Diff line number Diff line change
Expand Up @@ -367,7 +367,7 @@ pub(crate) struct TransactionInner {

type TransactionArc = Arc<Mutex<TransactionInner>>;

/// Functional implementation of how a new transation's sample rate is chosen.
/// Functional implementation of how a new transaction's sample rate is chosen.
///
/// Split out from `Client.is_transaction_sampled` for testing.
#[cfg(feature = "client")]
Expand Down
2 changes: 1 addition & 1 deletion sentry-core/src/scope/real.rs
Original file line number Diff line number Diff line change
Expand Up @@ -134,7 +134,7 @@ impl Drop for ScopeGuard {
stack.pop();
popped_depth
};
// NOTE: We need to drop the `stack` lock before panicing, as the
// NOTE: We need to drop the `stack` lock before panicking, as the
// `PanicIntegration` will want to lock the `stack` itself
// (through `capture_event` -> `HubImpl::with`), and would thus
// result in a deadlock.
Expand Down
4 changes: 2 additions & 2 deletions sentry-types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
# Sentry Rust SDK: sentry-types

This crate provides common types for working with the Sentry protocol or the
Sentry server. It's used by the Sentry Relay infrastructure as well as the
Sentry server. It's used by the Sentry Relay infrastructure as well as the
rust Sentry client.

Most of the types in this crate are serializable in one form or another.
Expand All @@ -26,7 +26,7 @@ so later versions might be added later.
### API Concepts

Most types are directly serializable or deserializable and try to implement
the `Default` type. This means that objects can be created conviently
the `Default` type. This means that objects can be created conviently
and missing attributes can be filled in:

```rust
Expand Down
2 changes: 1 addition & 1 deletion sentry-types/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@
//! ## API Concepts
//!
//! Most types are directly serializable or deserializable and try to implement
//! the `Default` type. This means that objects can be created conviently
//! the `Default` type. This means that objects can be created conveniently
//! and missing attributes can be filled in:
//!
//! ```rust
Expand Down
10 changes: 5 additions & 5 deletions sentry-types/src/protocol/session.rs
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ pub struct SessionUpdate<'a> {
#[serde(default)]
pub status: SessionStatus,

/// The number of errors that ocurred.
/// The number of errors that occurred.
#[serde(default)]
pub errors: u64,

Expand All @@ -150,16 +150,16 @@ pub struct SessionAggregateItem {
/// The distinct identifier.
#[serde(rename = "did", default, skip_serializing_if = "Option::is_none")]
pub distinct_id: Option<String>,
/// The number of exited sessions that ocurred.
/// The number of exited sessions that occurred.
#[serde(default, skip_serializing_if = "is_zero")]
pub exited: u32,
/// The number of errored sessions that ocurred, not including the abnormal and crashed ones.
/// The number of errored sessions that occurred, not including the abnormal and crashed ones.
#[serde(default, skip_serializing_if = "is_zero")]
pub errored: u32,
/// The number of abnormal sessions that ocurred.
/// The number of abnormal sessions that occurred.
#[serde(default, skip_serializing_if = "is_zero")]
pub abnormal: u32,
/// The number of crashed sessions that ocurred.
/// The number of crashed sessions that occurred.
#[serde(default, skip_serializing_if = "is_zero")]
pub crashed: u32,
}
Expand Down
4 changes: 2 additions & 2 deletions sentry-types/src/protocol/v7.rs
Original file line number Diff line number Diff line change
Expand Up @@ -782,7 +782,7 @@ impl Default for Breadcrumb {
/// An IP address, either IPv4, IPv6 or Auto.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Ord, PartialOrd, Hash, Default)]
pub enum IpAddress {
/// The IP address needs to be infered from the user's context.
/// The IP address needs to be inferred from the user's context.
#[default]
Auto,
/// The exact given IP address (v4 or v6).
Expand Down Expand Up @@ -1595,7 +1595,7 @@ pub struct Event<'a> {
/// A release identifier.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub release: Option<Cow<'a, str>>,
/// An optional distribution identifer.
/// An optional distribution identifier.
#[serde(default, skip_serializing_if = "Option::is_none")]
pub dist: Option<Cow<'a, str>>,
/// An optional environment identifier.
Expand Down

0 comments on commit 2fe26e0

Please sign in to comment.