Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix arguments naming and escape operator name in usageHtml #765

Merged
merged 9 commits into from
Sep 7, 2022

Conversation

DedSec256
Copy link
Contributor

@DedSec256 DedSec256 commented Aug 28, 2022

Some operator names are displayed incorrectly due to missing escaping; also, the argument names are duplicated.
This PR fixes that.

Before:
https://github.com/dotnet/fsharp/blob/0063f20f6cd49d016d5d234b9c1b7df00c2e9a4d/src/FSharp.Core/Nullable.fsi#L173
image
image

After:
image

  • Tests

cc @BoundedChenn31

@dsyme
Copy link
Contributor

dsyme commented Aug 30, 2022

Looks good. Will you add tests? I'm OK with taking as is.

@DedSec256
Copy link
Contributor Author

@dsyme, yes, we would like to add some tests for it in the near future.

@BoundedChenn31 BoundedChenn31 force-pushed the dedsec256-fix-for-operators branch from ced0f05 to 923ade5 Compare August 30, 2022 17:19
@DedSec256 DedSec256 changed the title Fix arguments naming and escape operator name in usageHtml [WIP] Fix arguments naming and escape operator name in usageHtml Aug 30, 2022
@DedSec256
Copy link
Contributor Author

@dsyme, we think it's ready

@dsyme
Copy link
Contributor

dsyme commented Aug 31, 2022

You probably want to exclude these from code formatting, or else format them

tests/FSharp.ApiDocs.Tests/files/FsLib1/OperatorsWithFsi.fsi needs formatting
tests/FSharp.ApiDocs.Tests/files/FsLib1/OperatorsWithFsi.fs needs formatting

@DedSec256
Copy link
Contributor Author

@dsyme, it could be merged I think (:

@dsyme dsyme merged commit 65074af into fsprojects:main Sep 7, 2022
@dsyme
Copy link
Contributor

dsyme commented Sep 7, 2022

Thanks!

@DedSec256 DedSec256 deleted the dedsec256-fix-for-operators branch September 8, 2022 10:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants