Skip to content

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 8, 2025

Fixes #[issue_number]

This PR addresses two improvements to the F# XML Documentation page as requested in the issue:

Changes

1. Added missing word "approach"

Fixed the sentence structure when describing the second method of writing XML documentation comments. Changed "This second way" to "This second approach" for consistency with how the two methods are introduced earlier in the document.

Before:

This second way enables you to specify separate notes...

After:

This second approach enables you to specify separate notes...

2. Added project file example for --warnon:3390

Added a practical example showing how to enable XML documentation validation warnings using the project file approach. The documentation previously only mentioned the --warnon:3390 command-line option without showing the MSBuild/project file equivalent.

Added:

<WarnOn>3390</WarnOn>

This example is placed immediately after the paragraph explaining the --warnon:3390 option, making it easy for developers to find the project file approach. The format is consistent with other property examples in the document (such as GenerateDocumentationFile) and follows the pattern documented in the F# compiler-options.md file.

These minimal changes improve the clarity and completeness of the documentation, providing users with both command-line and project file configuration options.

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve F# XML Docs page</issue_title>
<issue_description>In explaining the "second" approach, the word approach is missing.

Where --warnon is discussed, it would be nice to have an example of the project file approach to setting warnings.


Document Details

Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

Comments on the Issue (you are @copilot in this section)

Fixes #26636

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.


Internal previews

📄 File 🔗 Preview link
docs/fsharp/language-reference/xml-documentation.md docs/fsharp/language-reference/xml-documentation

@dotnet-policy-service dotnet-policy-service bot added the okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings. label Oct 8, 2025
@Copilot Copilot AI changed the title [WIP] Fix missing word in F# XML Docs tutorial Improve F# XML Documentation page with missing word and project file example Oct 8, 2025
@Copilot Copilot AI requested a review from BillWagner October 8, 2025 19:17
Copilot finished work on behalf of BillWagner October 8, 2025 19:17
Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is ready for final review, with one minor change.

@BillWagner BillWagner marked this pull request as ready for review October 9, 2025 13:38
@BillWagner BillWagner requested review from a team as code owners October 9, 2025 13:38
@Copilot Copilot AI review requested due to automatic review settings October 9, 2025 13:38
Copy link
Contributor

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR improves the F# XML Documentation page by addressing two specific documentation issues: adding a missing word for better sentence structure and providing a practical project file example for XML documentation warning configuration.

  • Added the missing word "approach" to maintain consistency when describing the second method of writing XML documentation comments
  • Added a project file example showing how to enable XML documentation validation warnings using <WarnOn>3390</WarnOn>

@BillWagner BillWagner requested a review from IEvangelist October 9, 2025 13:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dotnet-fsharp/svc okr-quality Content-quality KR: Concerns article defects (bugs), freshness, or build warnings.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Improve F# XML Docs page

2 participants