[Repo Assist] docs: update intro text to reference NuGet package instead of FSharp.Data.dll#1708
Draft
github-actions[bot] wants to merge 2 commits intomainfrom
Conversation
…Data.dll assembly Remove outdated references to loading FSharp.Data.dll from a local path. Update CsvProvider, JsonProvider and XmlProvider docs to say 'reference the FSharp.Data NuGet package' instead. Also remove the unnecessary '#r "System.Xml.Linq.dll"' directive from XmlProvider.fsx (System.Xml.Linq is part of the BCL in modern .NET and requires no explicit reference). Closes #1490 Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
🤖 This is an automated pull request from Repo Assist, an AI assistant for this repository.
Closes #1490
Problem
Three provider documentation files (
JsonProvider.fsx,CsvProvider.fsx,XmlProvider.fsx) still contained outdated text:FSharp.Data.dllassembly…"XmlProvider.fsx, this was followed by a standalone#r "System.Xml.Linq.dll"directive (unnecessary sinceSystem.Xml.Linqis part of the BCL in modern .NET)These instructions described the old approach of manually referencing a local
.dllfile, which is no longer how users install FSharp.Data.Changes
JsonProvider.fsx: Replace "The type provider is located in theFSharp.Data.dllassembly and namespace:" with "To use this type provider, reference theFSharp.DataNuGet package. Open the namespace:"CsvProvider.fsx: Same update — remove the old assembly-path framingXmlProvider.fsx: Same update + remove the stale#r "System.Xml.Linq.dll"directiveThe
#r "nuget: FSharp.Data,\{\{fsdocs-package-version}}"reference (undercondition: fsx) was already correct and is untouched. The GIF images referenced in the issue (docs/images/json.gifetc.) require screen-recording to regenerate and are out of scope for this PR.Test Status
dotnet run --project build/build.fsproj -- -t CheckFormat) passes — no changes needed