Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Use the XML exception tag in doc comments (F#) #766

Merged
merged 13 commits into from
Dec 23, 2020
Merged

Use the XML exception tag in doc comments (F#) #766

merged 13 commits into from
Dec 23, 2020

Conversation

kevinhartman
Copy link
Contributor

Changes:

  • Adds proper XML tags for any exceptions previously mentioned within the summary tag.
  • Enables warning of malformed F# doc comments (FS3390) as an error.

A few things to note:

  • At this time, only F# Tools 11.0.0 supports XML doc comment validation (release notes).
  • Code references don't seem to be validated yet, even by 11.0.0 (i.e. an incorrect cref won't be caught).
  • Parameter name reference validation actually works :)

Ref #699

@kevinhartman kevinhartman force-pushed the keha/except-tag-docs-fs branch from a77c131 to 44587e1 Compare December 7, 2020 04:00
@bamarsha bamarsha self-assigned this Dec 8, 2020
@bamarsha bamarsha self-requested a review December 8, 2020 00:16
@bamarsha
Copy link
Contributor

Hi @kevinhartman, sorry for the delay in reviewing this! I'll take a look on Monday. Also, #769 created some merge conflicts here - although that PR didn't actually change any of the doc comments, so the conflicts shouldn't be too bad to resolve. Since #769 was my fault, I'll resolve the merge conflicts for you unless you want to handle them. :)

@kevinhartman
Copy link
Contributor Author

kevinhartman commented Dec 12, 2020 •
edited
Loading

No worries, @SamarSha! I'm happy to resolve them :D I should be able to get to it in the next day or two.

kevinhartman
kevinhartman commented Dec 14, 2020
View reviewed changes
bamarsha
bamarsha reviewed Dec 14, 2020
View reviewed changes
Copy link
Contributor

@bamarsha bamarsha left a comment

Choose a reason for hiding this comment

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

Thanks for working on this and for resolving the merge conflicts! The compiler checks for invalid doc comments sound great. :)

@kevinhartman kevinhartman force-pushed the keha/except-tag-docs-fs branch from 1b06a00 to 456ea1c Compare December 15, 2020 03:40
@kevinhartman @bamarsha
Address review comments.
4ea5edb 
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
@kevinhartman kevinhartman force-pushed the keha/except-tag-docs-fs branch from 456ea1c to 4ea5edb Compare December 15, 2020 03:44
@kevinhartman
Copy link
Contributor Author

Thanks for working on this and for resolving the merge conflicts! The compiler checks for invalid doc comments sound great. :)

Thanks! :) Sorry about all of the param refs I'd missed. I'm used to Scala's multiple parameter lists for currying, but F#'s curried syntax without parenthesis threw me off!

bamarsha
bamarsha approved these changes Dec 18, 2020
View reviewed changes
Copy link
Contributor

@bamarsha bamarsha left a comment

Choose a reason for hiding this comment

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

Sorry about all of the param refs I'd missed. I'm used to Scala's multiple parameter lists for currying, but F#'s curried syntax without parenthesis threw me off!

No worries! Looks good, thanks again!

kevinhartman and others added 3 commits December 18, 2020 23:55
@kevinhartman @bamarsha
Update src/QsCompiler/Core/SymbolResolution.fs
2a53de2 
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
@kevinhartman @bamarsha
Update src/QsCompiler/SyntaxProcessor/ScopeTools.fs
a9e1318 
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
@kevinhartman
Merge branch 'main' into keha/except-tag-docs-fs
ace7e1e
bamarsha
bamarsha reviewed Dec 21, 2020
View reviewed changes
@bamarsha
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@bamarsha bamarsha mentioned this pull request Dec 22, 2020
Open
5 tasks
@kevinhartman @bamarsha
Update src/QsCompiler/SyntaxProcessor/ScopeTools.fs
a19ab08 
Co-authored-by: Sarah Marshall <33814365+samarsha@users.noreply.github.com>
@bamarsha
Copy link
Contributor

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 2 pipeline(s).

@github-actions github-actions bot merged commit 9eca36a into microsoft:main Dec 23, 2020
@bamarsha bamarsha mentioned this pull request Jan 27, 2021
Merged
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@bamarsha bamarsha bamarsha approved these changes

Assignees

@bamarsha bamarsha

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@kevinhartman @bamarsha