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

Fix typo in Map.find documentation. #317

Open
wants to merge 6 commits into
base: live
Choose a base branch
from

Conversation

xarxziux
Copy link

There's a typo in the Map.find documentation. Line 61 reads "The following examples shows how to use Map.filter." This PR corrects that to read "The following examples shows how to use Map.find."

cartermp and others added 6 commits June 20, 2018 08:24
* Fix broken table (MicrosoftDocs#269)

* Fix code indentation (MicrosoftDocs#267)

* corrected the output (MicrosoftDocs#276)

* Update collections.array - fsharp .md (MicrosoftDocs#271)

fixed signature for copy function

* fix and consolidate list.xyz2/xyz3 doc for input lists with different lengths (MicrosoftDocs#282)

* Fix escape sequence. (MicrosoftDocs#285)

* Add missing space (MicrosoftDocs#284)

* Fix order of arguments in foldBack lambda (MicrosoftDocs#286)

Running the following in F# Interactive will help explain why I believe this change is necessary:
> List.foldBack (fun elem acc -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 4 elem: 3 elem: 2 elem: 1 val it : int = 10
> List.foldBack (fun acc elem -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 0 elem: 4 elem: 7 elem: 9 val it : int = 10

The accumulator is the second argument in foldBack (contrary to fold where it is the first).
Positioning the arguments in reverse in an example is a great way to confuse a reader.

This also helps promote the fact that the state and list arguments to the folding function
are in the same order as their lambda counterparts.

Feel free to disagree :-).

* Fix Operators.atan2 description (MicrosoftDocs#287)

atan2(y, x) is related to atan(y/x), *not* atan(x/y)

* Fixed code formatting (MicrosoftDocs#288)

* Corrected prefix minus to prefix plus (MicrosoftDocs#289)

* Added missing line break

Added missing line break to class definition of Microsoft.FSharp.Reflection.UnionCaseInfo

* Removed Missing CustomOperationAttribute Issue MicrosoftDocs#266

* JoinConditionWord was Accidentally removed despite not being duplicated. Fixing this.

* Fix typo in Array2D.init docs

* Document that Map.pick can throw KeynotFoundException

* Update async.startchild['t]-method-[fsharp].md

Specify timeout behaviour

* Fix List.compareWith case

* Update walkthrough-using-visual-fsharp-to-create,-debug,-and-deploy-an-application.md

* Added treatment of null-values, and fixed incomplete text on IFormattable (MicrosoftDocs#301)

The `string` function casts to `IFormattable` internally. The original text only mentioned integer and floating point values, but in fact, there are many more values in the BCL that implement IFormattable. I improved the text to be more precise.

Furthermore, special treatment of `null` was not mentioned, I've added that. Expanded supported platforms, and fixed a typo.

* Update quotations.patterns-module-[fsharp].md (MicrosoftDocs#302)

Thanks @Columpio

* Clarified how ties are resolved (MicrosoftDocs#304)

* Add except to list modules (MicrosoftDocs#305)

The except function added in fsharp/fslang-design#41 doesn't have a doc here.
MicrosoftDocs#309)

* Fix broken table (MicrosoftDocs#269)

* Fix code indentation (MicrosoftDocs#267)

* corrected the output (MicrosoftDocs#276)

* Update collections.array - fsharp .md (MicrosoftDocs#271)

fixed signature for copy function

* fix and consolidate list.xyz2/xyz3 doc for input lists with different lengths (MicrosoftDocs#282)

* Fix escape sequence. (MicrosoftDocs#285)

* Add missing space (MicrosoftDocs#284)

* Fix order of arguments in foldBack lambda (MicrosoftDocs#286)

Running the following in F# Interactive will help explain why I believe this change is necessary:
> List.foldBack (fun elem acc -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 4 elem: 3 elem: 2 elem: 1 val it : int = 10
> List.foldBack (fun acc elem -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 0 elem: 4 elem: 7 elem: 9 val it : int = 10

The accumulator is the second argument in foldBack (contrary to fold where it is the first).
Positioning the arguments in reverse in an example is a great way to confuse a reader.

This also helps promote the fact that the state and list arguments to the folding function
are in the same order as their lambda counterparts.

Feel free to disagree :-).

* Fix Operators.atan2 description (MicrosoftDocs#287)

atan2(y, x) is related to atan(y/x), *not* atan(x/y)

* Fixed code formatting (MicrosoftDocs#288)

* Corrected prefix minus to prefix plus (MicrosoftDocs#289)

* Added missing line break

Added missing line break to class definition of Microsoft.FSharp.Reflection.UnionCaseInfo

* Removed Missing CustomOperationAttribute Issue MicrosoftDocs#266

* JoinConditionWord was Accidentally removed despite not being duplicated. Fixing this.

* Fix typo in Array2D.init docs

* Document that Map.pick can throw KeynotFoundException

* Update async.startchild['t]-method-[fsharp].md

Specify timeout behaviour

* Update walkthrough-using-visual-fsharp-to-create,-debug,-and-deploy-an-application.md

* Added treatment of null-values, and fixed incomplete text on IFormattable (MicrosoftDocs#301)

The `string` function casts to `IFormattable` internally. The original text only mentioned integer and floating point values, but in fact, there are many more values in the BCL that implement IFormattable. I improved the text to be more precise.

Furthermore, special treatment of `null` was not mentioned, I've added that. Expanded supported platforms, and fixed a typo.

* Update list.partition['t]-function-[fsharp].md
* Live -> master (MicrosoftDocs#313)

* Fix broken table (MicrosoftDocs#269)

* Fix code indentation (MicrosoftDocs#267)

* corrected the output (MicrosoftDocs#276)

* Update collections.array - fsharp .md (MicrosoftDocs#271)

fixed signature for copy function

* fix and consolidate list.xyz2/xyz3 doc for input lists with different lengths (MicrosoftDocs#282)

* Fix escape sequence. (MicrosoftDocs#285)

* Add missing space (MicrosoftDocs#284)

* Fix order of arguments in foldBack lambda (MicrosoftDocs#286)

Running the following in F# Interactive will help explain why I believe this change is necessary:
> List.foldBack (fun elem acc -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 4 elem: 3 elem: 2 elem: 1 val it : int = 10
> List.foldBack (fun acc elem -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 0 elem: 4 elem: 7 elem: 9 val it : int = 10

The accumulator is the second argument in foldBack (contrary to fold where it is the first).
Positioning the arguments in reverse in an example is a great way to confuse a reader.

This also helps promote the fact that the state and list arguments to the folding function
are in the same order as their lambda counterparts.

Feel free to disagree :-).

* Fix Operators.atan2 description (MicrosoftDocs#287)

atan2(y, x) is related to atan(y/x), *not* atan(x/y)

* Fixed code formatting (MicrosoftDocs#288)

* Corrected prefix minus to prefix plus (MicrosoftDocs#289)

* Added missing line break

Added missing line break to class definition of Microsoft.FSharp.Reflection.UnionCaseInfo

* Removed Missing CustomOperationAttribute Issue MicrosoftDocs#266

* JoinConditionWord was Accidentally removed despite not being duplicated. Fixing this.

* Fix typo in Array2D.init docs

* Document that Map.pick can throw KeynotFoundException

* Update async.startchild['t]-method-[fsharp].md

Specify timeout behaviour

* Fix List.compareWith case

* Update walkthrough-using-visual-fsharp-to-create,-debug,-and-deploy-an-application.md

* Added treatment of null-values, and fixed incomplete text on IFormattable (MicrosoftDocs#301)

The `string` function casts to `IFormattable` internally. The original text only mentioned integer and floating point values, but in fact, there are many more values in the BCL that implement IFormattable. I improved the text to be more precise.

Furthermore, special treatment of `null` was not mentioned, I've added that. Expanded supported platforms, and fixed a typo.

* Update quotations.patterns-module-[fsharp].md (MicrosoftDocs#302)

Thanks @Columpio

* Clarified how ties are resolved (MicrosoftDocs#304)

* Add except to list modules (MicrosoftDocs#305)

The except function added in fsharp/fslang-design#41 doesn't have a doc here.

* Correcting the Return Value in list.partition['t]-function-[fsharp].md  (MicrosoftDocs#309)

* Fix broken table (MicrosoftDocs#269)

* Fix code indentation (MicrosoftDocs#267)

* corrected the output (MicrosoftDocs#276)

* Update collections.array - fsharp .md (MicrosoftDocs#271)

fixed signature for copy function

* fix and consolidate list.xyz2/xyz3 doc for input lists with different lengths (MicrosoftDocs#282)

* Fix escape sequence. (MicrosoftDocs#285)

* Add missing space (MicrosoftDocs#284)

* Fix order of arguments in foldBack lambda (MicrosoftDocs#286)

Running the following in F# Interactive will help explain why I believe this change is necessary:
> List.foldBack (fun elem acc -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 4 elem: 3 elem: 2 elem: 1 val it : int = 10
> List.foldBack (fun acc elem -> printf "elem: %A " elem; elem + acc) [1;2;3;4] 0;;
elem: 0 elem: 4 elem: 7 elem: 9 val it : int = 10

The accumulator is the second argument in foldBack (contrary to fold where it is the first).
Positioning the arguments in reverse in an example is a great way to confuse a reader.

This also helps promote the fact that the state and list arguments to the folding function
are in the same order as their lambda counterparts.

Feel free to disagree :-).

* Fix Operators.atan2 description (MicrosoftDocs#287)

atan2(y, x) is related to atan(y/x), *not* atan(x/y)

* Fixed code formatting (MicrosoftDocs#288)

* Corrected prefix minus to prefix plus (MicrosoftDocs#289)

* Added missing line break

Added missing line break to class definition of Microsoft.FSharp.Reflection.UnionCaseInfo

* Removed Missing CustomOperationAttribute Issue MicrosoftDocs#266

* JoinConditionWord was Accidentally removed despite not being duplicated. Fixing this.

* Fix typo in Array2D.init docs

* Document that Map.pick can throw KeynotFoundException

* Update async.startchild['t]-method-[fsharp].md

Specify timeout behaviour

* Update walkthrough-using-visual-fsharp-to-create,-debug,-and-deploy-an-application.md

* Added treatment of null-values, and fixed incomplete text on IFormattable (MicrosoftDocs#301)

The `string` function casts to `IFormattable` internally. The original text only mentioned integer and floating point values, but in fact, there are many more values in the BCL that implement IFormattable. I improved the text to be more precise.

Furthermore, special treatment of `null` was not mentioned, I've added that. Expanded supported platforms, and fixed a typo.

* Update list.partition['t]-function-[fsharp].md

* Fixed formatting of README (MicrosoftDocs#291)
Fix line 61 to read `Map.find` instead of `Map.filter`.
@msftclas
Copy link

msftclas commented Sep 11, 2018

CLA assistant check
All CLA requirements met.

@dend
Copy link
Contributor

dend commented Sep 11, 2018

⚠️ Validation status: warnings

File Status Preview URL Details
docs/conceptual/seq.tail['t]-function-[fsharp].md ⚠️Warning Details
README.md ✅Succeeded
docs/conceptual/list.partition['t]-function-[fsharp].md ✅Succeeded
docs/conceptual/map.find['key,'t]-function-[fsharp].md ✅Succeeded

docs/conceptual/seq.tail['t]-function-[fsharp].md

For more details, please refer to the build report.

Note: If you changed an existing file name or deleted a file, broken links in other files to the deleted or renamed file are listed only in the full build report.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants