Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Making Documentation Easier To Use #927

Open
chuckberrypi opened this issue Dec 10, 2022 · 0 comments
Open

Making Documentation Easier To Use #927

chuckberrypi opened this issue Dec 10, 2022 · 0 comments

Comments

@chuckberrypi
Copy link
Contributor

I'm new to F#, and enjoying working through this year's advent of code using it. One of the pain points I'm experiencing is just the layout of the FSharp.org documentation because I have to scroll through the whole page to read all of the functions in a particular namespace to find the one I want. This is really frustrating when I'm trying to see if F# has an equivalent function to another language I'm used to. For example, Rust's iterators have a map_filter method, which is equivalent to Seq.choose. But since I didn't know how it was named, I had to scroll down the whole page to see if there was a mapFilter function, then scroll around to read all of the function names until I found ones that seem like they might be promising. The fact that I can only see one or two function names at a time is really slowing down how fast I can learn F#'s api.

I'd love it if the FSharp.org website could add a sidebar that lists all of the functions in that namespace so that someone leaning the language can scan through them to discover them. Some nice examples include .NET's documentation (folded in a tree) or Rust's docs. Or you could put all of them up at the top. Really, any way to see all of the named functions all together would be super.

Thanks!

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

No branches or pull requests

1 participant