Use of the now public Range propery of PreXmlDoc #1128
Merged
Conversation
This file contains 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
…ty of PreXmlDoc to save resources
dawedawe
commented
Jul 2, 2023
| if Array.isEmpty d.UnprocessedLines then | ||
| None | ||
| elif d.UnprocessedLines |> Array.exists (fun s -> s.Contains("<summary>")) then | ||
| Some(d.UnprocessedLines, d.Range) | ||
| Some(d.UnprocessedLines, xd.Range) |
There was a problem hiding this comment.
use xd for consistency
There was a problem hiding this comment.
isn't xd.Range a mistake, xd is not defined.
The above variable is still defined as d.
There was a problem hiding this comment.
See line 17, xd is the PreXmlDoc passed to the function.
dawedawe
commented
Jul 2, 2023
| else | ||
| let lines = | ||
| match d.UnprocessedLines with | ||
| | [||] -> [| " <summary></summary>" |] | ||
| | [| c |] -> [| $" <summary>%s{c.Trim()}</summary>" |] | ||
| | cs -> [| yield " <summary>"; yield! cs; yield " </summary>" |] | ||
|
|
||
| Some(lines, d.Range) | ||
| Some(lines, xd.Range) |
There was a problem hiding this comment.
use xd for consistency
baronfel
approved these changes
Jul 2, 2023
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.
WHAT
🤖 Generated by Copilot at e5b624e
The pull request optimizes the code that handles XML documentation for F# symbols in two files:
AddMissingXmlDocumentation.fsandConvertTripleSlashCommentToXmlTaggedDoc.fs. It avoids unnecessary computations and simplifies the access to the range of thePreXmlDocnodes.🤖 Generated by Copilot at e5b624e
🚀📝🧹
WHY
Some time ago, the Range property of PreXmlDoc was made public. After updating fsc, we can now make use of it to save resources in some range checks.
HOW
🤖 Generated by Copilot at e5b624e
XmlDocby moving it inside theifbranch that checks the position range of thePreXmlDoc(link, link)xd.Rangeinstead ofd.RangeinAddMissingXmlDocumentation.fsandConvertTripleSlashCommentToXmlTaggedDoc.fs(link, link, link)