Conversation
- Expand JsonProvider.fsx EmbeddedResource section with step-by-step setup instructions, fsproj snippet, naming convention explanation, and common pitfall warning - Expand CsvProvider.fsx to include a brief EmbeddedResource section pointing readers to the full guide in JsonProvider.fsx Addresses #1315. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Contributor
Author
|
✅ Pull request created: #1631 |
3 tasks
dsyme
deleted the
repo-assist/improve-embeddedresource-docs-ce80ff578cb31dcf
branch
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
1 participant
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 draft PR from Repo Assist, an AI assistant.
Summary
Expands the
EmbeddedResourcedocumentation that has been a recurring source of confusion for users (see #1315, which has been open since 2020 and received multiple "me too" acknowledgements).Changes
docs/library/JsonProvider.fsxThe existing section was a single paragraph with just the code example. This PR expands it with:
(EmbeddedResource)tag in the.fsprojEmbeddedResourceparameter value — the key insight that path separators become dots, prefixed with the assembly name.dllto verify the resource namedocs/library/CsvProvider.fsxPreviously just said "see JSON provider docs" with no details. Now adds a brief section explaining the
EmbeddedResourcepattern for CSV with a concrete one-liner example, before directing readers to the full guide.Why this matters
Issue #1315 (reported in 2020) describes hours lost to figuring out the
EmbeddedResourcesyntax experimentally. The naming convention (AssemblyName, AssemblyName.path.with.dots.to.file) is non-obvious and underdocumented. This PR brings the documentation up to the level needed to avoid that confusion.Test Status
Documentation-only change — no build or test run required.
Addresses #1315.