dotnet / dotnet/dotnet-api-docs

Move the example

Open
#1,007 0 comments 0 reactions 0 assignees View on GitHub
area-System.IO dotnet-api/prod Pri2 untriaged
Dominant language
C#
Stars
949
Forks
1.7k
Avg merge
2d 19h
Merged PRs (30d)
52

Description

The example under `CreateFromFile(String)` should be moved to `CreateFromFile(String, FileMode, String)`, because it actually uses that overload of the method

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 25bccff2-0202-40c0-278d-9f791e353b93
* Version Independent ID: a4d0765b-0488-c971-977c-cf4960b58b88
* Content: [MemoryMappedFile.CreateFromFile Method (System.IO.MemoryMappedFiles)](https://docs.microsoft.com/en-us/dotnet/api/system.io.memorymappedfiles.memorymappedfile.createfromfile?view=netframework-4.7.2)
* Content Source: [xml/System.IO.MemoryMappedFiles/MemoryMappedFile.xml](https://github.com/dotnet/dotnet-api-docs/blob/master/xml/System.IO.MemoryMappedFiles/MemoryMappedFile.xml)
* Product: **dotnet-api**
* GitHub Login: @dotnet-bot
* Microsoft Alias: **dotnetcontent**

Contributor guide

Open the contributing guide

Research direction

Open xml/System.IO.MemoryMappedFiles/MemoryMappedFile.xml and locate the example under CreateFromFile(String). Move it to CreateFromFile(String, FileMode, String), since the example uses that overload. Done means the example appears under the matching API overload and no longer under the single-argument method.

Written by the indexing model from the issue text.

Assessment

Tech stack
csharp
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.