dotnet / dotnet/dotnet-api-docs
Confusing "implement a Close method"
- Dominant language
- C#
- Stars
- 949
- Forks
- 1.7k
- Avg merge
- 3d 27m
- Merged PRs (30d)
- 49
Description
### Describe the issue or suggestion
On the [Object.Finalize](https://learn.microsoft.com/en-us/dotnet/api/system.object.finalize?view=net-10.0) page. The "How finalization works" section mentions `Close`, capitalized and in a code format. If I understand correctly, from the Essential C# book. A close function means any method that manually frees resources. This is not a special type of method, a language feature. Merely suggested style (whether that is strictly enforced like PowerShell verbs, or not).
As this is a significant part of .NET, making it clear what is meant here could be improved. As is, the very verbose writing style without any further explanation, makes it seem like something it is not?
---
#### Document Details
⚠ *Do not edit this section. It is required for learn.microsoft.com ➟ GitHub issue linking.*
* ID: e7082f23-745f-cf11-4e8a-640495328ec1
* Version Independent ID: e7082f23-745f-cf11-4e8a-640495328ec1
* Platform ID: 0a4aa0f1-db33-0b9d-1de0-34304b5deb48
* Content: [Object.Finalize Method (System)](https://learn.microsoft.com/en-us/dotnet/api/system.object.finalize?view=net-10.0#see-also)
* Content Source: [xml/System/Object.xml](https://github.com/dotnet/dotnet-api-docs-temp/blob/live/xml/System/Object.xml)
* Service: **dotnet-api**
* Sub-service: **system**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**
Contributor guide
Research direction
Open xml/System/Object.xml and locate the Object.Finalize content for the "How finalization works" section. Read the surrounding explanation and clarify what "Close" means, distinguishing it from a special method or language feature; done means the section no longer suggests that Close has special .NET semantics.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- csharp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 72/100