rspec/rules/S3971/csharp/rule.adoc

== Why is this an issue?

``++GC.SuppressFinalize++`` requests that the system not call the finalizer for the specified object. This should only be done when implementing ``++Dispose++`` as part of the https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose[Dispose Pattern].

This rule raises an issue when ``++GC.SuppressFinalize++`` is called outside that pattern.


ifdef::env-github,rspecator-view[]

'''
== Implementation Specification
(visible only on this page)

=== Message

Remove this call to "GC.SuppressFinalize".


=== Highlighting

GC.SuppressFinalize call


'''
== Comments And Links
(visible only on this page)

=== relates to: S3234

=== relates to: S3881

endif::env-github,rspecator-view[]
migrate rule descriptions to new education format 2023-05-03 11:06:20 +02:00			`== Why is this an issue?`

Restructure one-lang rspecs 2021-04-28 16:49:39 +02:00			``++GC.SuppressFinalize++`` requests that the system not call the finalizer for the specified object. This should only be done when implementing ``++Dispose++`` as part of the https://docs.microsoft.com/en-us/dotnet/standard/garbage-collection/implementing-dispose[Dispose Pattern].

			This rule raises an issue when ``++GC.SuppressFinalize++`` is called outside that pattern.
Fix the missing default metadata fields 2021-04-28 18:08:03 +02:00

Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00
Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`ifdef::env-github,rspecator-view[]`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00
			`'''`
			`== Implementation Specification`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in. 2023-05-25 14:18:12 +02:00			`=== Message`

			`Remove this call to "GC.SuppressFinalize".`


			`=== Highlighting`

			`GC.SuppressFinalize call`
RULEAPI-666: Migrate the "List of parameters", "Highlighting" and "Message" fields from jira RSPEC (#346) 2021-09-20 15:38:42 +02:00

RULEAPI-576: add a horizontal rule between rule description and comments 2021-06-08 15:52:13 +02:00			`'''`
Export comments and rspec-to-rspec links from jira 2021-06-02 20:44:38 +02:00			`== Comments And Links`
			`(visible only on this page)`

Inline adoc when include has no additional value (#1940) Inline adoc files when they are included exactly once. Also fix language tags because this inlining gives us better information on what language the code is written in. 2023-05-25 14:18:12 +02:00			`=== relates to: S3234`

			`=== relates to: S3881`

Fix the comment display: rule-id, timestamp, GH visibility, link direction 2021-06-03 09:05:38 +02:00			`endif::env-github,rspecator-view[]`