[repo-assist] docs: clarify 'hide' keyword vs 'hidden' identifier in literate script example - #1238
Draft
github-actions[bot] wants to merge 1 commit into
Draft
Conversation
…mple Fixes the confusion raised in #1220 where the text says 'hide' but the example uses a variable named 'hidden'. Added a note that 'hide' is the keyword in (*** hide ***) and 'hidden' is just a regular F# identifier. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
5 tasks
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 PR was created by Repo Assist, an automated AI assistant.
Closes #1220
Summary
The documentation for the
hidecommand indocs/sidebyside/sidescript.fsxwas confusing because it said "use thehidecommand" but the code example immediately below used a variable namedhidden. This made it unclear whetherhiddenwas a keyword or just a coincidental identifier choice.Fix
Added a clarifying note:
hideis the keyword used in(*** hide ***), andhiddenin the example is just a regular F# identifier — not a keyword.Changes
docs/sidebyside/sidescript.fsx— added one-line clarification noteTest Status
This is a documentation-only change (no compiled code). The docs file is an
.fsxliterate script used by fsdocs to generate HTML documentation.Add this agentic workflow to your repo
To install this agentic workflow, run