Confusing "implement a Close method"

Open Beginner friendly
#12,957 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
72/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Quiet
Tech stack
csharp
Domain
documentation

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.

Description

area-System.Runtime untriaged
Describe the issue or suggestion

On the Object.Finalize 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)
  • Content Source: xml/System/Object.xml
  • Service: dotnet-api
  • Sub-service: system
  • GitHub Login: @dotnet-bot
  • Microsoft Alias: dotnetcontent
Dominant language
C#
Stars
950
Forks
1.7k
Avg merge
3d 5h
Merged PRs (30d)
38

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from dotnet/dotnet-api-docs

All issues in dotnet/dotnet-api-docs

Similar issues

More C# issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.