{"id":52902,"date":"2024-07-31T10:05:00","date_gmt":"2024-07-31T17:05:00","guid":{"rendered":"https:\/\/devblogs.microsoft.com\/dotnet\/?p=52902"},"modified":"2024-07-31T10:05:00","modified_gmt":"2024-07-31T17:05:00","slug":"enhancing-help-in-fsi","status":"publish","type":"post","link":"https:\/\/devblogs.microsoft.com\/dotnet\/enhancing-help-in-fsi\/","title":{"rendered":"Enhancing #help in F# Interactive"},"content":{"rendered":"
\n

This is a guest blog post by David Schaefer. David is a freelance software developer with a focus on functional programming. He’s a member of Amplifying F#<\/a>, a community initiative to improve the F# ecosystem. There he works mainly on developer tooling and helps maintain various open-source projects.<\/p>\n<\/blockquote>\n

F# interactive, or fsi<\/a>, is a favorite among F# programmers. This component executes F# scripts and provides a REPL (Read, Evaluate, Print Loop) for F#. The feature is well-established and documented, with extensive configuration opportunities (see dotnet fsi --help<\/code>).<\/p>\n

This post describes the most recent addition to fsi<\/code> – the #help \"idn\"<\/code> directive, which allows users to quickly obtain documentation for things like library functions.<\/p>\n

Background<\/h2>\n

Some of you might remember our Unlocking F# Potential<\/a> session from last November when I showed the first prototype of fsih<\/a>. This small package, modeled after the h<\/code> function of the Elixir IEx<\/a> REPL, provides documentation available at your fingertips without the need to context switch to a browser. The feedback I got was very encouraging, I released the package and blogged about it in the F# Advent<\/a>.<\/p>\n

The next logical step was to integrate it into fsi<\/code> itself, removing the hassle of referencing the package in every fsi<\/code> session. The first try was made during an Amplifying F# session<\/a> back in January. For various reasons I wasn’t able to finish it at that time. A second attempt was started in May, this time with financial backing from the Amplifying F# Open Collective<\/a>.<\/p>\n

Implementation and discussion<\/h2>\n

The PR<\/a> sparked a good conversation about how to make the functionality available to fsi<\/code> users. My initial port used a new hash directive called #h<\/code>. However, as hash directives in fsi<\/code> are parsed with the regular F# parser, that meant we had to wrap the expression in quotation marks, like #h \"List.map\"<\/code>.<\/p>\n

Brian<\/a> proposed the idea of using a method in the fsi<\/code> object that is available in every fsi<\/code> session. This would allow us to use the method without the need for quotation marks, e.g., fsi.h List.map<\/code>. I liked the idea and made the necessary changes to the PR. <\/p>\n

In parallel, Kevin<\/a> started to work on the parser<\/a> to remove the need for quotation marks, as he favored reusing the existing #help<\/code> hash directive for the new functionality. As the primary maintainer of fsi<\/code>, his opinion was the most important one. So, I adapted the PR again to use the #help<\/code> directive. To my great joy, the PR was merged and is already available in the latest .NET 9 preview. With Kevin’s PR also merged, quotation marks are now optional.<\/p>\n

The usage<\/h2>\n

So where does this leave us? Now, when you invoke the #help<\/code> directive in fsi<\/code>, you will see a new entry: #help \"idn\"<\/code> (where idn<\/code> stands for identifier):<\/p>\n

\"fsi<\/p>\n

You can use it like this:<\/p>\n

\"fsi<\/p>\n

Et voil\u00e0, you get the functionality from the fsih<\/code> package in fsi<\/code> without any additional dependencies.<\/p>\n

To keep things simple and to avoid bloating F#, the dependency of fsih<\/code> on Spectre.Console<\/code> was not ported over. The output is just uncolored plain text. A follow-up PR might add some coloring with the built-in coloring capabilities.<\/p>\n

A few caveats<\/h2>\n

It’s possible to run into type constraint issues when using the functionality with functions like List.sum<\/code>:<\/p>\n

\"fsi<\/p>\n

You will see something similar when you just type List.sum<\/code> to get the signature of the function:<\/p>\n

\"fsi<\/p>\n

You can still get the documentation by helping F# infer the type:<\/p>\n

\"fsi<\/p>\n

Acknowledgements<\/h2>\n

Overall, I’m quite happy with the result of the porting effort. It would not have been possible without the generous supporters of the Amplifying F# Open Collective<\/a>. So once again, I want to express my gratitude to all of you and to all reviewers of the PR. If you are interested in getting involved and helping out with continuous improvements in the F# ecosystem please checkout Amplifying F#<\/a>.<\/p>\n","protected":false},"excerpt":{"rendered":"

The ‘#help’ directive in F# Interactive can now quickly access documentation instantly within the REPL.<\/p>\n","protected":false},"author":139675,"featured_media":52903,"comment_status":"open","ping_status":"","sticky":false,"template":"","format":"standard","meta":{"_acf_changed":false,"footnotes":""},"categories":[685,636],"tags":[73,7858,85],"class_list":["post-52902","post","type-post","status-publish","format-standard","has-post-thumbnail","hentry","category-dotnet","category-fsharp","tag-f","tag-fsi","tag-interactive"],"acf":[],"blog_post_summary":"

The ‘#help’ directive in F# Interactive can now quickly access documentation instantly within the REPL.<\/p>\n","_links":{"self":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/52902","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/users\/139675"}],"replies":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/comments?post=52902"}],"version-history":[{"count":0,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/posts\/52902\/revisions"}],"wp:featuredmedia":[{"embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media\/52903"}],"wp:attachment":[{"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/media?parent=52902"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/categories?post=52902"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/devblogs.microsoft.com\/dotnet\/wp-json\/wp\/v2\/tags?post=52902"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}