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

F1 Help in VS taking to old version of F# library documentation #12253

Open
2 of 3 tasks
dsyme opened this issue Oct 15, 2021 · 2 comments
Open
2 of 3 tasks

F1 Help in VS taking to old version of F# library documentation #12253

dsyme opened this issue Oct 15, 2021 · 2 comments
Labels
Area-LangService-Navigation go to definition, F1 help + the FCS APIs related to it Area-VS VS support for F# not covered elsewhere Bug Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code. Theme-Simple-F# A cross-community initiative called "Simple F#", keeping people in the sweet spot of the language.
Milestone

Comments

@dsyme
Copy link
Contributor

dsyme commented Oct 15, 2021

We need to do an end-to-end sweep over what F1 Help is doing.

The fix appears to be to adjust the query service so that we do this:

 Microsoft.FSharp.Control.FSharpAsync`1   --> https://fsharp.github.io/fsharp-core-docs/reference/fsharp-control-fsharpasync.html

and in general like this (putting aside some issues with the `1 and so on)

 Microsoft.AAA.BBB.CCC   --> https://fsharp.github.io/fsharp-core-docs/reference/aaa-bbb-ccc.html

If necesary fsdocs/FSharp.Formatting can be modified to generate additional redirecting target pages

@dsyme dsyme added the Bug label Oct 15, 2021
@dsyme
Copy link
Contributor Author

dsyme commented Oct 29, 2021

I notice the .NET docs have a mechanism for specifying F1 keyword targets, e.g.

f1_keywords:
 - let!_FS

We could perhaps add long lists of the necessary forwarding tokens to the language reference sections.

@dsyme
Copy link
Contributor Author

dsyme commented Mar 3, 2022

I posted a question here dotnet/dotnet-api-docs#7724 but got no reply as yet

@dsyme dsyme added Impact-High (Internal MS Team use only) Describes an issue with extreme impact on existing code. Area-VS-Editor VS editor support for F# code, not covered elsewhere labels Mar 3, 2022
@KevinRansom KevinRansom removed the Impact-High (Internal MS Team use only) Describes an issue with extreme impact on existing code. label Mar 9, 2022
@dsyme dsyme added Area-LangService-API Area-FCS Area-LangService-Navigation go to definition, F1 help + the FCS APIs related to it and removed Area-VS-Editor VS editor support for F# code, not covered elsewhere Area-FCS Area-LangService-API labels Mar 30, 2022
@dsyme dsyme added Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code. Area-VS VS support for F# not covered elsewhere Theme-Simple-F# A cross-community initiative called "Simple F#", keeping people in the sweet spot of the language. labels Jun 9, 2022
@vzarytovskii vzarytovskii added this to the Backlog milestone Sep 21, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-LangService-Navigation go to definition, F1 help + the FCS APIs related to it Area-VS VS support for F# not covered elsewhere Bug Impact-Medium (Internal MS Team use only) Describes an issue with moderate impact on existing code. Theme-Simple-F# A cross-community initiative called "Simple F#", keeping people in the sweet spot of the language.
Projects
Status: New
Development

No branches or pull requests

3 participants