From: ArtisticRoomba <145879011+ArtisticRoomba@users.noreply.github.com>
Date: Sat, 29 Nov 2025 00:42:13 +0000 (-0800)
Subject: Properly document AtmosDeviceEnabled(Disabled)Event (#41613)
X-Git-Url: https://git.smokeofanarchy.ru/gitweb.cgi?a=commitdiff_plain;h=037a5598b7f258362f47f2a458e9fd9e0a263ebc;p=space-station-14.git

Properly document AtmosDeviceEnabled(Disabled)Event (#41613)

kill misnomers
---

diff --git a/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs b/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs
index 6fe5d86df2..66aa9b0bfa 100644
--- a/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs
+++ b/Content.Shared/Atmos/Piping/Components/AtmosDeviceDisabledEvent.cs
@@ -1,7 +1,12 @@
 namespace Content.Shared.Atmos.Piping.Components;
 
 /// <summary>
-///     Raised directed on an atmos device when it is enabled.
+/// <para>Raised directed on an AtmosDeviceComponent when it has been removed from
+/// the GridAtmosphereComponent it was attached to.
+/// This can occur when it has been requested manually or when the device has been unanchored.</para>
+///
+/// <para>Any information that you were tracking about the grid should
+/// probably be cleared out here.</para>
 /// </summary>
 [ByRefEvent]
-public readonly record struct AtmosDeviceDisabledEvent;
\ No newline at end of file
+public readonly record struct AtmosDeviceDisabledEvent;
diff --git a/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs b/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs
index d656367245..5f829c7d59 100644
--- a/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs
+++ b/Content.Shared/Atmos/Piping/Components/AtmosDeviceEnabledEvent.cs
@@ -1,7 +1,13 @@
 namespace Content.Shared.Atmos.Piping.Components;
 
 /// <summary>
-///     Raised directed on an atmos device when it is enabled.
+/// <para>Raised directed on an AtmosDeviceComponent when it has been added to
+/// a GridAtmosphereComponent.
+/// This can occur when it has been requested manually or when the device has been anchored.</para>
+///
+/// <para>You can use this to cache specific information about the grid the device is on,
+/// though be careful with caching references to objects that can be removed or changed at any time
+/// (such as <see cref="GasMixture"/>s).</para>
 /// </summary>
 [ByRefEvent]
-public readonly record struct AtmosDeviceEnabledEvent;
\ No newline at end of file
+public readonly record struct AtmosDeviceEnabledEvent;