docs: land leftover Copilot nits from the 6.0.0 pass - #127
Merged
Merged
Conversation
why.md missing-field example, void Add, release checklist, XML docs for Direct/!?, Operators conversion wording, DocFX alert selectors and link RGB, SECURITY.md triggers, VS Code task, changelog tryGet and 5.0.0.25 notes. Closes #114 Closes #115 Closes #116 Closes #117 Closes #118 Closes #119 Closes #120 Closes #121 Closes #122 Closes #123 Closes #124 Closes #125 Closes #126
There was a problem hiding this comment.
🟡 Changes recommended
Resolve the SECURITY.md trigger inconsistencies and align the VS Code task with the documented tested invocation.
Get a fresh assessment by requesting another Copilot review.
Pull request overview
This PR lands leftover documentation, release guidance, security-policy, styling, and VS Code task corrections from the 6.0.0 review pass.
Changes:
- Corrects API examples, operator documentation, and invocation semantics.
- Updates release notes, changelog entries, and workflow trigger guidance.
- Fixes DocFX styling and replaces the obsolete VS Code task.
File summaries
| File | Summary |
|---|---|
SECURITY.md |
Documents workflow triggers. |
FSharp.Interop.Dynamic/TopLevelOperators.fsi |
Clarifies !? behavior. |
FSharp.Interop.Dynamic/Operators.fsi |
Documents operator result handling. |
FSharp.Interop.Dynamic/Dyn.fsi |
Clarifies invocation semantics. |
docfx/template/public/main.css |
Fixes theme styling. |
docfx/docs/why.md |
Corrects examples and terminology. |
docfx/docs/releasing.md |
Generalizes release guidance. |
docfx/docs/operators.md |
Fixes the void-method example. |
CHANGELOG.md |
Corrects release notes and tryGet wording. |
.vscode/tasks.json |
Replaces the deleted build script task. |
Review details
Suppressed comments (2)
.vscode/tasks.json:17
- The repository configures Microsoft.Testing.Platform in
global.json, and the documented/CI invocation isdotnet test --project Tests/Tests.fsproj(CONTRIBUTING.md:32,.github/workflows/dotnet.yml:44). Keep this task on that invocation rather than introducing a different positional form, so the editor task follows the tested source-of-truth command.
"command": "dotnet test Tests/Tests.fsproj --configuration Release",
SECURITY.md:100
- This new row says Scorecard SARIF uploads run on schedule and
workflow_dispatch, but the required-checks table above still saysSARIF on masterat line 88. Those descriptions now contradict each other; update the first table to describe the same non-PR triggers.
| Scorecard SARIF upload | Non-PR events (`master` push, schedule, `workflow_dispatch`) |
- Files reviewed: 10/10 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| | NuGet publish + Sigstore provenance | Version tags `v*.*.*` only (Trusted Publishing / `NuGet/login`) | | ||
| | OSV-Scanner (full) | Push to `master`, weekly schedule, `workflow_dispatch` | | ||
| | Scorecard SARIF upload | Non-PR events (`master` push, schedule, `workflow_dispatch`) | | ||
| | GitHub Pages deploy | Push to `master` | |
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.
Copilot comments from the September PRs that were still true on master.
Closes #114 (why.md section 2)
Closes #115 (operators.md void Add)
Closes #116 (VS Code task)
Closes #117 (releasing.md)
Closes #118 (CHANGELOG tryGet)
Closes #119 (Dyn.invocation Direct)
Closes #120 (DocFX theme)
Closes #121 (SECURITY.md triggers)
Closes #122 (
:?is a type test)Closes #123 (pythonnet sketch opens Operators)
Closes #124 (Operators XML conversion vs unbox)
Closes #125 (
!?XML)Closes #126 (5.0.0.25 release notes)
Not in this PR: #107 (not merged), OpenSSF Passing badge (#63, out of scope).