Skip to content

Commit

Permalink
Merge pull request #177 from dawedawe/document_fullname_footgun
Browse files Browse the repository at this point in the history
document the FullName footgun we run into
  • Loading branch information
dawedawe authored Dec 13, 2023
2 parents 89e6b39 + fecc13e commit addb946
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions docs/content/Getting Started Writing.fsx
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,13 @@ Target.create
)

(**
### Known footguns to avoid
There's a footgun in the FCS-API that you can easily trigger when working on an analyzer:
Accessing the [FullName](https://fsharp.github.io/fsharp-compiler-docs/reference/fsharp-compiler-symbols-fsharpentity.html#FullName) property of the [FSharpEntity](https://fsharp.github.io/fsharp-compiler-docs/reference/fsharp-compiler-symbols-fsharpentity.html) type throws an exception if the entity doesn't have one.
Use the [TryGetFullName](https://fsharp.github.io/fsharp-compiler-docs/reference/fsharp-compiler-symbols-fsharpentity.html#TryGetFullName) function for safe access.
[Previous]({{fsdocs-previous-page-link}})
[Next]({{fsdocs-next-page-link}})
Expand Down

0 comments on commit addb946

Please sign in to comment.