Improve F# XML Documentation page with missing word and project file example #49031
+7
−1
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.
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:
After:
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:
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 asGenerateDocumentationFile
) 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
💡 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