Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Fix description and add return value and remarks #338

Open
wants to merge 1 commit into
base: live
Choose a base branch
from
Open

Fix description and add return value and remarks #338

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion docs/conceptual/option.filter['t]-function-[fsharp].md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ ms.assetid: ff36174c-0820-47e4-b7ce-6fa93f19bcb5

# Option.filter<'T> Function (F#)

Invokes a function on an optional value that itself yields an option.
Evaluates whether the value contained in the option should remain, or be filtered out.

**Namespace/Module Path**: Microsoft.FSharp.Core.Option

Expand Down Expand Up @@ -43,6 +43,15 @@ Type: **'T** [option](https://msdn.microsoft.com/library/b08add48-34bf-4410-80a1

The input option.

## Return Value

The input option if it has a value and the predicate evaluates to true for this value; otherwise, `None`.

## Remarks
The expression `Option.filter f inp` evaluates to `match inp with Some x when f x -> inp | _ -> None.`

This function is named `Filter` in compiled assemblies. If you are accessing the function from a language other than F#, or through reflection, use this name.

## Platforms
Windows 8, Windows 7, Windows Server 2012, Windows Server 2008 R2

Expand Down